【发布时间】：2014-07-24 11:43:29
【问题描述】：
我想为我班级的每个 val 和 def 创建 ScalaDoc 条目。问题是 val 位于模式定义中，不知道如何使用 /** */ 语法。
例子：
class C(id: String) {
val (part1, part2) = {
.....
(expr1, expr2)
}
}
我如何记录part1和part2？
在向 this documentation 询问 ScalaDoc 之前，我已经阅读过。
【问题讨论】：
-
你可以做
private val parts = { ... }; /** ... */ val part1 = parts._1; /** ... */ val part2 = parts._2;。 -
好，我想说：“您可以记录生成元组的函数（如果需要，将代码提取到函数中）”但这仅适用于 val 是私有的内部开发人员文档.我更喜欢 @rightfold 解决方案，除非有一些特殊的 scaladoc 东西。