有两种方法可以从您的 Scala 代码中生成 HTML 格式的 API 文档。这些选项是
- 使用 sbt 来完成它，
- 使用 scaladoc 命令行工具。
使用 sbt
从您的 Scala 代码生成 API 文档最简单、最常用的方法是使用构建工具 sbt。
在 sbt shell 中，通过运行 doc 来生成 Scaladoc
> doc
[info] Main Scala API documentation to target/scala-2.12/api...
[info] model contains 1 documentable templates
[info] Main Scala API documentation successful.
[success] Total time: 20 s
HTML 文档将显示在相应的 target/ 目录（或多个项目的构建的目录）中，sbt 会将这些目录打印到控制台输出。
有关在您的系统上使用 sbt 的更多信息，请参阅 下载说明，了解 在命令行上使用 Scala 和 sbt 入门。
有关在 sbt 中配置 Scaladoc 的更多信息，请参阅 sbt 参考手册的 生成 API 文档 部分。
使用 scaladoc 命令
如果您使用 Scala 命令直接启动带有 scala 的控制台或使用 scalac 进行编译，那么您也应该有一个 scaladoc 命令行实用程序。这是一种更高级、更不常用的生成 Scaladoc 的方法。
$ scaladoc src/main/scala/App.scala
model contains 1 documentable templates
这将把 HTML 放置在当前目录中。这可能不是您想要的。最好输出到子目录。要指定不同的目标目录，请使用 -d 命令行选项
$ scaladoc -d build/ src/main/scala/App.scala
有关 scaladoc 命令及其支持的其他命令行选项的更多信息，请参见 scaladoc --help。
对于包含多个 Scala 源文件和库依赖项的更复杂项目，此命令的操作难度更大。这就是为什么使用 sbt（见上文）更容易并且更适合生成 Scaladoc。
Scaladoc 命令的存在是因为它早于 sbt 的开发，但也因为它对于 Scala 开发团队研究 Scaladoc 的错误报告很有用。
有关直接使用 Scala 命令（如 scaladoc）的更多信息，请参阅 Scala 入门。