Java API文档

时间:2012-01-11 15:17:18

标签: java api jar intellisense javadoc

如何将Java文档添加到.JAR文件中,以便在人们使用我的JAR文件并键入“。”时Eclipse将显示可用API(intellisense)的文档。

更多信息

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

更新 intellisense仅在导出源时显示。但是我想隐藏源代码。我怎么能绕过这个?

3 个答案:

答案 0 :(得分:3)

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

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

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

答案 1 :(得分: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的使用者将始终拥有最新的javadoc,无需进一步干预

答案 2 :(得分:0)

在Eclipse中,使用源导出项目。

执行文件 - &gt;导出... - &gt; Java - &gt; JAR文件 - &gt;下一步

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

然后继续,直到创建JAR。

修改:在问题编辑后,此答案不再有效,但仍然有用。