当前位置：文江博客话题详情

Java API 文档

发布于 2024-12-25 22:50:59 字数 243 浏览 3 评论 0原文

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

更多信息

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

更新仅当导出源时才会显示智能感知。不过我想隐藏源代码。我该如何解决这个问题？

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

江湖彼岸 2025-01-01 22:50:59

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

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

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

回复收藏 0 原文

夏花。依旧 2025-01-01 22:50:59

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

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

步骤 2：确保 Eclipse 始终附加这些文档，使用 maven-eclipse-plugin< /a>

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

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

Maven has a very elegant way of handling this.

Step 1: The Maven way to generate javadocs: http://maven.apache.org/plugins/maven-javadoc-plugin/

Step 2: To ensure Eclipse always attaches these docs, use the maven-eclipse-plugin

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

Once these two steps are done, the consumers of your API jars will always have your latest javadocs with no further intervention

回复收藏 0 原文