如何使用 Play 2 "doc" 命令？

Question

Play 似乎通过“build”或“doc”命令生成文档。

我们应该如何使用这个功能？

• 是否生成文本文件？
• 是生成html文件吗？
• 如何查阅此文档？
• 它是为人类制造的还是内部的东西？

Answer 1

doc 命令并非特定于 Play。由于 play/activator wrap sbt，它们继承了sbt doc 命令，该命令将为项目中的所有源文件生成 scaladocs。运行它是非常不言自明的。你会看到这样的输出：

[info] Main Scala API documentation to /path/to/project/target/scala-2.10/api...

如果您导航到该目录，您会看到一堆生成的 html 文件，其中包含您项目的 scaladocs。所以是的，它正在生成 html 文件，是的，它是为人类设计的。打开target/scala-2.10/api/index.html 会更有说服力。