关于Java：当Javadoc未附加到依赖项时，如何在Maven eclipse插件中引用Javadocs

我在开发中使用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属性不会解决此问题。

从Maven Eclipse插件常见问题解答

The following example shows how to do
this in the command-line:

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

or in your pom.xml:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

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

我正在运行STS 2.8.1，基本上是Eclipse + Spring工具；在现有的maven项目中，我右键单击该项目-> maven->下载源并下载JavaDocs

如如何从其他存储库中使用Maven Eclipse插件下载源代码和Javadoc工件中所述，您可以执行以下操作：

在Eclipse中，转到Windows->首选项-> Maven。选中"下载Artifact Javadoc"框。这对我来说很好。

您可能会考虑通过使用安装文件目标将javadoc jar手动安装到本地存储库中并传递-Dclassifier = javadoc选项来完全避免此问题。完成后，mvn生成的.classpath应该正确。

如果使用远程存储库作为中央存储库的代理，还可以将Javadocs部署到该存储库，那么使用该代理的其他所有人现在也将自动获取Javadocs。

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

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

1.如果不是非Maven项目：

下载javadocs jar或压缩文件(如果可用)，并将其放在某个目录中。
右键单击IDE Eclipse中的应用程序项目，单击"属性"，然后选择" Java构建路径"，然后选择" Java构建路径"下的"选项卡库"。现在，展开要与Java docs / source链接的jar。选择Javadoc位置链接，然后单击Edit按钮，将出现一个新窗口，我们需要在其中选择javadocs jar路径。单击"确定"，我们已将javadoc / source链接到相应的jar。

2.如果是Maven专案

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

您可以通过右键单击IDE中的项目并单击Java Build Path并选择Java Build Path下的Libraries选项卡，然后展开所需的jar，在此处进行验证，单击"编辑"按钮时，您将看到带有相应jar的Javadoc / Source，如下图所示。

3.如果是Maven项目，并且我们正在设置默认行为：

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

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

现在单击Apply并保存它，现在当您创建新的Maven项目时，默认情况下，将下载Javadocs并将其与项目中所有相关的jar链接。
您可以通过右键单击该项目和Properties来进行验证，然后在Java Build路径下可以看到javadocs与所有jar链接在一起，如下所示。

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

方法3有点昂贵，因为将为所有依赖的jar下载javadoc / source，可能是您对所有依赖jar的javadocs / source都不感兴趣。

依赖项的来源会有所帮助吗？您可以使用-DdownloadSources=true告诉eclipse插件下载这些文件(并在.classpath中进行引用)。