当javadoc没有附加到依赖关系时,如何在Maven的eclipse插件中引用javadocs到依赖关系

我在开发中使用Eclipse,Maven和Java。 我使用Maven来下载依赖项(jar文件和javadoc,如果可用的话)以及Maven的eclipse插件来为Eclipse生成.project和.classpath文件。 当下载的依赖项没有附加javadoc时,我手动在.classpath文件中为javadoc添加一个链接,这样我就可以在Eclipse中看到依赖关系的javadoc。 然后当我运行Maven的eclipse插件重新生成.classpath文件时,它当然会消除这种变化。

有没有办法configurationMaven的eclipse插件,在运行Maven的eclipse插件时自动为javadoc添加classpath属性?

我只对javadoc和/或源代码不在Maven仓库中提供依赖的问题感兴趣,这种情况对我来说最为常见。 使用downloadSources和/或downloadJavadocs属性不会帮助解决这个问题。

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

如果您使用远程回购代理作为中央代理,则也可以将javadoc部署到该回购,然后使用该代理的其他人也将自动获取javadoc。

从Maven Eclipse插件常见问题

以下示例显示了如何在命令行中执行此操作:

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> 

我正在运行基本上是eclipse + spring工具的STS 2.8.1; 在现有的Maven项目中,我右键单击项目 – > maven – >下载源文件并下载JavaDocs

正如在如何使用Maven Eclipse插件从其他存储库下载源代码和javadoc工件中所述的那样? , 你可以这样做:

在Eclipse中,进入Windows-> Preferences-> Maven。 选中“下载工件Javadoc”。 这对我来说很好。

Maven首选项

通常Javadoc不主要用作依赖关系。 因为这些在编译和运行时都不需要。 这只是在开发或debugging时帮助开发人员。

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

1.如果是非Maven项目:

下载javadocs jar或压缩文件,无论可用并将其放置在某个目录中。 右键单击IDE Eclipse中的应用程序项目,单击属性,然后selectJava Build Path,然后selectJava Build Path下的选项卡Libraries。 现在展开你想用java docs / source链接的jar。 selectJavadoc位置链接,然后单击编辑button,出现一个新窗口,我们需要selectjavadocs jarpath。 点击确定,我们已经把javadoc / source与各自的jar包联系起来了。

在这里输入图像说明

2.如果这是一个maven项目

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

在这里输入图像说明

您可以通过右键单击IDE中的项目并单击Java Build Path,然后selectJava Build Path下的Libraries选项卡,然后展开所需的jar,在这里单击Editbutton时将会看到链接的pathJavadoc / Source与相应的jar,如下图所示。

在这里输入图像说明

3.如果是Maven项目,我们正在设置默认行为:

Eclipse会在开始的时候随着主要的jar一起在下载javadoc / source。 默认将指令设置为Maven来下载项目中链接的所有jar文件的Javadoc / sources。

单击Windows – 首选项 – selectMaven,然后单击checkboxDownload Artifact Javadoc,如下所示

在这里输入图像说明

现在点击apply并保存它,现在当你创build新的Maven项目时,默认情况下,Javadoc将被下载并链接到项目中的所有相关jar。
您可以通过右键单击项目和属性进行validation,并且在Java Build path下可以看到javadoc与所有的jar相关联,如下所示。

在这里输入图像说明

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

方法3是有点昂贵,因为javadoc / sources将被下载所有的依赖jar,可能你对javadocs / sources对所有的依赖jar没有兴趣。

有依赖的来源帮助? 你可以告诉eclipse插件使用-DdownloadSources=true来下载这些插件(并在.classpath中引用它们)