如何使用Play 2「doc」命令？

Question

似乎通過「構建」或「doc」命令生成文檔。

我們應該如何使用此功能？

• 它是否生成文本文件？
• 它是否生成html文件？
• 我該如何諮詢這個文檔？
• 它甚至是爲人類製造的還是內部的東西？

Answer 1

doc命令不是特定於Play。由於play/activator wrap sbt，它們繼承了sbt doc命令，該命令將爲項目中的所有源文件生成scaladoc。運行它很自我解釋。你會看到如下所示的結果：

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

如果你導航到該目錄，你會看到一串包含您的項目scaladocs生成的html文件。所以是的，它生成的html文件，是的它是爲人類。開放target/scala-2.10/api/index.html將更有說服力。