无法在 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 inside 的描述包。

解决方法

我终于找到了答案

Scaladoc 注释可以放在字段、方法、类、特征、 对象。目前,scaladoc 不支持直接解决 文档包。有一个专门的github问题,你可以在那里 检查问题的当前状态。

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