【问题标题】:How can I view javadocs that have been added to a maven repository?如何查看已添加到 maven 存储库的 javadocs?
【发布时间】:2011-03-01 18:33:37
【问题描述】:

我知道我可以使用 maven 来提取 javadocs 以获得一个工件(如果它们已被添加),它应该作为一个 JAR(对吗?),然后我可以解压缩并浏览它。我的问题是,我试图找出一系列工件中的哪些具有我正在寻找的特定包。我可以下载六个 javadoc 包,将它们全部解压缩,然后一次打开一个索引文件,但这听起来很不愉快。

一定有更好的方法!我注意到 Nexus 支持 javadoc 工件浏览,但显然只在 Pro 版本中(我们没有,而且不太可能很快得到)。我更喜欢 GUI 解决方案,但我会接受命令行答案,前提是它类似于 showmethedocs groupId:artifactId [version]

ETA:澄清一下:当我专门比较一个工件的多个版本,或多个不同但相似的工件(“foo:core”与“foo:utils”与“foo:extra”或其他东西)时'不确定什么工件实际上包含我需要的包/类。也许有更好的方法可以做到这一点,我问错了问题?如果我将每个工件添加为 Maven 依赖项并检查 Eclipse 中的文档,这可以工作,但如果有 20 个工件的旧版本,并且其中一个具有我正在寻找的方法,则可能需要一段时间。

【问题讨论】:

  • 如果您执行shipmaster 推荐的下载行,那么Eclipse 应该自动将javadocs 与类文件关联起来。如果您在 Eclipse 中寻找一个特定的类(导航菜单 - > 打开类型),那么它应该显示源代码(如果源代码已下载)以及当您将鼠标悬停在该包的使用上时该源代码的 javadocs。这对你不起作用?
  • 如果有一个云 Web 服务(例如 read-the-docs)可以让您浏览碰巧存在的几乎所有 Maven 工件的 javadocs,那当然会很好。

标签: maven-2 javadoc


【解决方案1】:

Netbeans 为 Maven 项目提供了下载 Javadoc 功能。首先运行它,然后出现 View Javadoc 选项。

【讨论】:

    【解决方案2】:

    如果是针对已发布到 Maven Central 的工件,您可以使用此 Web 服务:

    http://www.javadoc.io

    【讨论】:

      【解决方案3】:

      如果你运行

      mvn eclipse:eclipse -DdownloadSources=true -DdownloadJavadocs=true

      从您项目的根目录,它将远程存储库上的所有源代码和 javadocs 下载到您的本地存储库。如果您有 m2eclipse,您可以在首选项中将其设置为在后台自动发生,然后深入到您想要的依赖项,右键单击然后说“打开 Javadoc”。见:

      http://www.sonatype.com/people/2008/10/browsing-javadoc-for-dependencies-in-eclipse-m2eclipse/

      【讨论】:

      • 这很好,不过如果我不想在命令行和 GUI 之间切换,我可以将每个工件添加为依赖项,右键单击 Maven 依赖项部分,然后选择“下载 Javadoc ”。当然,我想添加/删除它们,但总比没有好。
      猜你喜欢
      • 2014-01-01
      • 1970-01-01
      • 2014-11-22
      • 2013-09-30
      • 2016-10-25
      • 1970-01-01
      • 2011-06-07
      • 2011-04-25
      • 2014-06-11
      相关资源
      最近更新 更多