有兩種方式可以從 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 文件將顯示在 sbt 列印至主控台輸出的對應 target/ 目錄（或有多個專案的建置目錄）。
如需瞭解如何在系統上使用 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。