如何获得游戏！框架的Javadocs？

Question

我即将开始一个新项目，我们决定使用Play！。我已经配置了我的IDE（Eclipse Luna），但不幸的是，当我悬停任何函数，类等时，没有任何文档的迹象。

浏览互联网我想出了Play的github仓库（https://github.com/playframework/playframework），他们有一个文档文件夹（https://github.com/playframework/playframework/tree/master/documentation）。

那么，如何根据Github文档文件夹生成Javadoc？

PS：我正在使用最新的Play版本，即2.3.6，其中播放命令被激活器取代。

Answer 1

您必须将引号内的完整参数传递给activator命令。 这对我有用：

.\activator "eclipse with-source=true"

我认为activator otherwhise将eclipse和with-source=true识别为两个单独的命令，而不是一个带参数的命令。

Answer 2

文档不清楚，这就是为什么你和我得到这个恼人的错误。

1. 进入您的网络应用程序文件夹
2. $ ./activator
3. [你的项目] $ eclipse with-source = true

调用./activator eclipse有效，但./activator eclipse with-source=true并不是（暗示？）它在激活器shell中运行。

希望有所帮助。 :)

Answer 3

我遇到了同样的问题，所以我只使用了eclipse插件，这对其他lib也很有用： http://marketplace.eclipse.org/content/java-source-attacher

Answer 4

使用sbt或activator生成带有源的eclipse项目：eclipse with-source=true。更多细节here。或者，您可以使用java decompiler进行日食 - 它可能会让您了解您的库。

Answer 5

Play服务器通过以下方式为您提供文档：

http://localhost:9000/@documentation/api/java/index.html

除非您需要离线文档，否则在第https://www.playframework.com/documentation页上有链接可浏览不同版本的API，例如Java 2.3x或Scala 2.3x。目前提供的最新文档版本为2.4.x

Answer 6

最终，我决定使用较旧版本的Play！框架，因为它带有“游戏”二进制文件（不是激活者）。

将自己置于我的项目中，输入： $ play > eclipse with-source=true

我不知道为什么，但我不能同样访问：

[1] $ activator   > eclipse with-source=true

因为它被卡在[1]上并没有继续下去。