【问题标题】:How to obtain Play! framework's Javadocs?如何获得玩!框架的Javadocs?
【发布时间】:2014-11-25 15:20:04
【问题描述】:

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

查看 Internet,我想出了 Play 的 github 存储库 (https://github.com/playframework/playframework),他们有一个文档文件夹 (https://github.com/playframework/playframework/tree/master/documentation)。

那么,如何根据他们的 Github 文档文件夹生成 Javadoc?

PS:我使用的是最新的 Play 版本,即 2.3.6,其中 play 命令被替换为 activator。

【问题讨论】:

    标签: java eclipse playframework javadoc playframework-2.3


    【解决方案1】:

    您必须将引号内的完整参数传递给激活器命令。 这对我有用:

    .\activator "eclipse with-source=true"
    

    我猜激活器会将eclipsewith-source=true 识别为两个单独的命令,而不是一个带有参数的命令。

    【讨论】:

      【解决方案2】:

      文档不清楚,这就是为什么你和我都会遇到这个烦人的错误。

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

      调用./activator eclipse 有效,但./activator eclipse with-source=true 不能(暗示?)它是从激活器外壳中运行的。

      希望对您有所帮助。 :)

      【讨论】:

        【解决方案3】:

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

        【讨论】:

        • 我发现如果你使用Maven或Ivy,这个问题就消失了:自动下载源代码和javadocs。无论如何,我从 Play 转身!进入 Vaadin,我感觉更舒服了。
        【解决方案4】:

        使用 sbt 或激活器生成带有源的 eclipse 项目:eclipse with-source=true。更多详情here。或者,您可以将java decompiler 用于 eclipse - 它可能会让您了解您的库。

        【讨论】:

        • 不工作...我使用“activator new yabe”创建了一个新应用程序,将目录更改为 yabe,键入“activator eclipse with-sources=true”并出现以下消息:[info]成功为项目创建了 Eclipse 项目文件:yabe 不是有效命令:with-source 不是有效项目 ID:with-source 预期的“:”(如果选择配置)[[next]]
        • [[continues]]不是一个有效的键:with-source(类似:watch-sources、watchSources、sources)..我试过这个并开始工作:activator eclipse sources 从**加载项目定义*\yabe\project 将当前项目设置为 yabe(在构建文件中:/***y/yabe/) 即将为您的项目创建 Eclipse 项目文件。成功为项目创建了 Eclipse 项目文件:yabe[success]...但是没有创建 Javadocs...我做错了什么?
        【解决方案5】:

        Play 服务器在以下位置为您提供文档:

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

        除非您需要离线文档,否则在页面 https://www.playframework.com/documentation 上有用于浏览不同版本的 API 的链接,例如 Java 2.3xScala 2.3x。当前提供的最新文档版本是2.4.x

        【讨论】:

        • 谢谢,但我已经知道文档在那里。我真正想要的是将Javadocs设置为eclipse...
        • Eclipse 可以fetch the docs via url,但如果您愿意,您可以将 html 文件打包成 jar 或 zip 并提供给 Eclipse。
        • 嗯,你是对的。无论如何,看起来应用程序必须正在运行,不是吗?
        • 是的,如果您使用本地 url 来运行文档,本地服务器必须正在运行。如果您在线,则play framework's urls are good
        • 我设置了在线目录,但没有显示 Javadocs: 注意:获取 Javadoc 时发生异常。有关详细信息,请参阅日志。
        【解决方案6】:

        最终,我决定使用旧版本的 Play!框架,因为它带有“播放”二进制文件(不是激活器)。

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

        我不知道为什么,但我无法以类似方式访问:

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

        因为它卡在 [1] 上不会继续。

        【讨论】:

          猜你喜欢
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 2015-07-20
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 2022-01-24
          相关资源
          最近更新 更多