无法在 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 注释可以位于字段、方法、类、特征、对象之前。目前，scaladoc 不支持文档包的直接解决方案。有一个专门的 github 问题，您可以在其中查看问题的当前状态。