如何使用Play 2“doc”命令？

Question

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

我们应该如何使用此功能？

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

Answer 1

doc命令不是Play特有的。由于play / activator包装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会更有说服力。