scala - パターン定義で val を文書化する方法

Question

クラスのすべての val と def に ScalaDoc エントリを作成したいと考えています。/** */問題は、val がパターン定義内にあり、構文の使用方法がわからないことです。

例：

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

part1とpart2を文書化するにはどうすればよいですか?

ScalaDoc についてこのドキュメントを尋ねる前に読んだことがあります。

Answer 1

そのはず

  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]     ^

ヒューリスティックは、囲んでいるエンティティでドキュメントが検出されない場合にのみ破棄するように改善される可能性があります。