无法在 ScalaDoc (Scala 3) 中添加包描述
Cannot add package description in ScalaDoc (Scala 3)
我无法使用 Scala 3 在 ScalaDoc 中添加包描述
/** package description */
package foo {
/** some scaladoc comment */
def method():A = ???
}
然后我用 sbt (1.5.3) 生成文档
sbt> doc
我在 index.html 文件中没有得到包 本身 的描述，只有 method [=20= 的描述]包装内。
我终于找到了答案
Scaladoc comments can go before fields, methods, classes, traits,
objects. For now, scaladoc doesn't support straightforward solution to
document packages. There is a dedicated github issue, where you can
check the current status of the problem.
我无法使用 Scala 3 在 ScalaDoc 中添加包描述
/** package description */
package foo {
/** some scaladoc comment */
def method():A = ???
}
然后我用 sbt (1.5.3) 生成文档
sbt> doc
我在 index.html 文件中没有得到包 本身 的描述，只有 method [=20= 的描述]包装内。
我终于找到了答案
Scaladoc comments can go before fields, methods, classes, traits, objects. For now, scaladoc doesn't support straightforward solution to document packages. There is a dedicated github issue, where you can check the current status of the problem.