scala - 无法在 ScalaDoc (Scala 3) 中添加包描述

Question

我无法使用 Scala 3 在 ScalaDoc 中添加包描述

/** package description */
package foo {
    /** some scaladoc comment */
    def method():A = ???
}

然后我用 sbt (1.5.3) 生成文档

sbt> doc

我没有得到包裹的描述 本身在 index.html文件，但只有 method 的描述 内包。

Answer 1

我终于找到了答案

Scaladoc comments can go before fields, methods, classes, traits,objects. For now, scaladoc doesn't support straightforward solution todocument packages. There is a dedicated github issue, where you cancheck the current status of the problem.

https://dotty.epfl.ch/docs/usage/scaladoc/scaladocDocstrings.html