首页 > 解决方案 > 无法在 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 内部的描述。

标签: scalascaladocscala-3

解决方案


我终于找到了答案

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

https://github.com/lampepfl/dotty/issues/11284


推荐阅读