通常 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 位置链接并单击编辑按钮,将出现一个新窗口,我们需要在其中选择 javadocs jar 路径。单击确定,我们已将 javadoc/source 与相应的 jar 链接起来。
2.如果是maven项目
如果我们使用的是 Maven 项目,则在 Project Explorer 视图中的项目下的 Maven 依赖项下的 jar 文件,如下所示。现在右键单击要添加 Javadoc/源的 jar 文件, 选择 Maven,然后单击要与项目链接的 Javadoc 或源。现在 IDE 将自动下载所需的 javadoc/source 并将其与项目中的相应 jar 链接。
您可以通过右键单击IDE中的项目并单击Java Build Path并选择Java Build Path下的Libraries选项卡然后展开所需的jar来验证这一点,当您单击Edit按钮时,您将看到链接的路径带有相应 jar 的 Javadoc/Source,如下图所示。
3. 如果是 Maven 项目并且我们正在设置默认行为:
Eclipse 将在开始时下载 javadoc/source 以及所需的主要 jar。默认情况下,Maven 设置指令下载项目中链接的所有 jar 的 Javadoc/源。
点击 Windows - 首选项 - 选择 Maven 并点击复选框 Download Artifact Javadoc 如下图所示
现在单击应用并保存它,现在当您创建新的 Maven 项目时,默认情况下 Javadocs 将被下载并与项目中的所有依赖 jar 链接。
您可以通过右键单击项目和属性进行验证,在 Java Build 路径下可以看到 javadocs 与所有 jar 链接,如下所示。
如果您的项目是 Maven 项目,那么最好使用第二种方法,因为通过使用这种方法,IDE 和 Maven 会负责下载 Javadoc/源的正确版本并将其与相关 jar 链接。
方法 3rd 有点昂贵,因为将为所有依赖 jar 下载 javadoc/sources,可能您对所有依赖 jars 的 javadocs/sources 不感兴趣。