java - Maven 依赖与 javadocs

Question

3 个问题:

下面是 JUnit 的两个 Maven 依赖项。我已经在网上搜索了几个小时，似乎无法确定第二个是 Javadoc + 代码还是只有 Javadoc。我需要一个还是两个？此外，将 Javadoc 包含在开发项目中但不包含在生产构建中的最有效方法是什么？ (我不希望为每台机器上的每个依赖项手动下载 javadoc。)

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
</dependency>

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~

<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>4.11</version>
  <classifier>javadoc</classifier>
</dependency>

编辑:问题:

• 这些依赖关系有什么区别？
• 我需要两者吗 他们能够使用依赖项并且手头有 Javadoc？
• 将 Javadoc 用于开发的最佳做法是什么？

Answer 1

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

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

<强>1。如果是非maven项目: 下载 javadocs jar 或压缩文件，无论什么可用，并将其放在某个目录中。 右键单击 IDE Eclipse 中的应用程序项目，单击属性并选择 Java 构建路径，然后选择 Java 构建路径下的选项卡库。现在展开您要与 java 文档/源链接的 jar。选择 Javadoc 位置链接并单击编辑按钮，将出现一个新窗口，我们需要在其中选择 javadocs jar 路径。单击“确定”，我们已将 javadoc/source 与相应的 jar 链接起来。

<强>2。如果是maven项目

如果我们使用的是Maven项目，则在Project Explorer View 中，进入项目下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/源代码以及所需的主要 jar。 默认情况下，Maven 的设置指令是为项目中链接的所有 jar 下载 Javadoc/源代码。

点击 Windows – preferences – 选择 Maven 并点击 Download Artifact Javadoc 复选框，如下所示

现在单击应用并保存它，现在当您创建新的 Maven 项目时，默认情况下 Javadocs 将被下载并与项目中所有依赖的 jar 链接。
您可以通过右键单击项目和属性进行验证，在 Java 构建路径下可以看到 javadoc 与所有 jar 链接，如下所示。

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

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