Java API 文档答案

【问题标题】：Java API documentationJava API 文档
【发布时间】：2012-02-07 22:50:37
【问题描述】：

如何将 Java 文档添加到 .JAR 文件中，以便在人们使用我的 JAR 文件并键入“.”时Eclipse 将显示可用 API（智能感知）的文档。

更多信息

我创建了 java doc，但是当我导出 jar 文件时，它在其他项目中使用时不包含智能感知。这就是我遇到的麻烦。

更新智能感知仅在导出源时显示。但是我想隐藏源代码。我该如何解决这个问题？

【问题讨论】：

Writing JavaDocs
添加 Java 文档可能会有所帮助。它曾经与 Netbeans 一起工作，但不确定它是否会在 Eclipse 中。

标签： java api jar intellisense javadoc

【解决方案1】：

如果您不想在您的 .jar 中包含整个源代码，您可以只压缩/压缩 javadocs（但是您可以生成它们。我使用 Eclipse 中的 Project->Generate Javadoc 菜单选项来完成） )。然后，最终用户可以将它们“附加”到项目构建路径设置中的引用库。

项目库的 javadoc 位置属性可以是 URL、本地目录或本地存档文件。

在注意到您的编辑后，我可能想提一下 Ant 有一个 javadoc task 可以在构建期间生成您的 javadocs。

【讨论】：

【解决方案2】：

Maven 有一种非常优雅的方式来处理这个问题。

第 1 步：生成的 Maven 方式 javadocs：http://maven.apache.org/plugins/maven-javadoc-plugin/

第 2 步：为确保 Eclipse 始终附加这些文档，请使用 maven-eclipse-plugin

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-eclipse-plugin</artifactId>
    <configuration>
      <downloadJavadocs>true</downloadJavadocs>
    </configuration>
</plugin>

完成这两个步骤后，您的 API jar 的使用者将始终拥有您最新的 javadocs，而无需进一步干预

【讨论】：

【解决方案3】：

在 Eclipse 中，使用源代码导出项目。

执行文件 -> 导出... -> Java -> JAR 文件 -> 下一步

然后选中复选框导出 java 源文件和资源。

然后继续，直到创建 JAR。

编辑：在问题中编辑后，此答案不再有效，但仍然有用。

【讨论】：