Question

我在开发中使用Eclipse，Maven和Java。我使用Maven下载依赖项（jar文件和javadoc可用时）和Maven的eclipse插件来生成Eclipse的.project和.classpath文件。当下载的依赖项没有连接javadoc时，我在.classpath文件中手动添加javadoc的链接，这样我就可以在Eclipse中看到依赖项的javadoc。然后，当我运行Maven的eclipse插件来重新生成.classpath文件时，它当然会消除这种变化。

有没有办法配置Maven的eclipse插件，以便在运行Maven的eclipse插件时自动为javadoc添加类路径属性？

我只对那些没有为maven资源库中的依赖项提供javadoc和/或源代码的答案感兴趣，这种情况最常见。使用downloadSources和/或downloadJavadocs属性对这个问题没有帮助。

Answer 1

来自Maven Eclipse插件FAQ

以下示例说明了如何操作这在命令行中：

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

或在您的pom.xml中：

<project>
  [...]
  <build>
    [...]
    <plugins>
      [...]
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-eclipse-plugin</artifactId>
        <configuration>
          <downloadSources>true</downloadSources>
          <downloadJavadocs>true</downloadJavadocs>
        </configuration>
      </plugin>
      [...]
    </plugins>
    [...]
  </build>
  [...]
</project>

Answer 2

我正在运行STS 2.8.1，它基本上是eclipse + spring工具;在现有的maven项目中，我右键单击了项目 - ＆gt; maven - ＆gt;下载源代码并下载JavaDocs

Answer 3

如How to download sources and javadoc artifacts with Maven Eclipse plugin from other repository?中所述，您可以这样做：

在Eclipse中转到Windows-＆gt;首选项＆GT; Maven的。选中显示＆＃34; Download Artifact Javadoc。＆＃34;这对我来说效果很好。

Maven Preferences

Answer 4

您可以考虑通过使用install-file goal手动将javadoc jar手动安装到本地存储库并传入-Dclassifier = javadoc选项来完全避免此问题。一旦你这样做，mvn生成的.classpath应该是正确的。

如果您使用远程仓库作为中央代理，您也可以将javadocs部署到该仓库，然后使用该代理的其他所有人也将自动获取javadoc。

Answer 5

通常，Javadocs主要不用作依赖项。因为在编译和运行时都不需要这些。它只是在开发或调试时帮助开发人员。

假设使用java IDE Eclipse，我们可以使用引用的java文档。以下是我们可以将javadocs / sources与相应的jar关联起来的方法。

<强> 1。如果是非maven项目：

下载javadocs jar或压缩文件，无论可用，并将其放在某个目录中。右键单击IDE Eclipse中的应用程序项目，单击Properties并选择Java Build Path，然后选择Java Build Path下的选项卡Libraries。现在展开要与java docs / source链接的jar。选择Javadoc位置链接并单击Edit按钮，将出现一个新窗口，我们需要选择javadocs jar路径。单击OK，我们已将javadoc / source与相应的jar链接。

<强> 2。如果这是一个maven项目

如果我们正在使用Maven项目，那么在Project Explorer视图中的项目下转到Maven依赖项下的jar文件，如下所示。现在右键单击要添加Javadoc / source的jar文件，然后选择Maven，然后单击要与项目链接的Javadoc或Source。现在IDE将自动下载所需的javadoc / source，并将其与项目中相应的jar链接。

您可以通过右键单击IDE中的项目来验证这一点，然后单击Java Build Path并选择Java Build Path下的Libraries选项卡，然后展开所需的jar，当您单击Edit按钮时，您将看到Javadoc / Source与相应jar的链接路径，如下图所示。

第3。如果是Maven项目，我们正在设置默认行为：

Eclipse将在开始时以水下方式下载javadoc / source以及主要的jar。默认情况下，将指令设置为Maven以下载项目中链接的所有jar的Javadoc / sources。

单击Windows - 首选项 - 选择Maven，然后单击下载Artifact Javadoc复选框，如下所示

现在点击apply并保存它，现在当你创建新的Maven项目时，默认情况下Javadocs将被下载并链接到项目中的所有相关的jar。
您可以通过右键单击项目和属性来验证，并在Java Build path下可以看到javadocs与所有jar链接，如下所示。

如果您的项目是Maven项目，那么最好使用第二种方法，因为通过使用这种方法，IDE和Maven负责下载正确版本的Javadoc / source并将其与相关jar连接起来好。

方法3的成本有点高，因为所有相关的罐子都会下载javadoc / sources，可能你对所有相关罐子的javadocs / sources不感兴趣。

Answer 6

依赖的来源会有帮助吗？您可以告诉eclipse插件使用-DdownloadSources=true

下载它们（并在.classpath中引用它们）

当javadoc没有附加到依赖项时，如何将javadocs引用到Maven的eclipse插件中的依赖项

6 个答案: