scala – 如何在模式定义中记录val

发布时间：2020-12-16 18:35:58 所属栏目：安全来源：网络整理

导读：我想为我班级的每个val和def创建 ScalaDoc条目.问题是vals位于模式定义中,并且不知道如何使用/ ** * /语法. 例： class C(id: String) { val (part1,part2) = { ..... (expr1,expr2) }} 我如何记录part1和part2？在向this documentation询问ScalaDoc之前我

我想为我班级的每个val和def创建 ScalaDoc条目.问题是vals位于模式定义中,并且不知道如何使用/ ** * /语法.

例：

class C(id: String) {
   val (part1,part2) = {
         .....
         (expr1,expr2)
   }
}

我如何记录part1和part2？

在向this documentation询问ScalaDoc之前我已经读过了.

解决方法

它应该是

val (
    /** Part one. */
    x,/** Part two. */
    y
  ) = (1,2)

但对于有缺陷的启发式

/** To prevent doc comments attached to expressions from leaking out of scope
 *  onto the next documentable entity,they are discarded upon passing a right
 *  brace,bracket,or parenthesis.
 */
def discardDocBuffer(): Unit = ()

在-Xlint下你会看到

[warn] /home/apm/goofy/src/main/scala/docked.scala:10: discarding unmoored doc comment
[warn]     /** Part two. */
[warn]     ^

也许只有在封闭实体上没有发现文档时才可以改进启发式以丢弃.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!