如何为javadocs创建可分发的jar?

时间:2011-08-19 19:56:28

标签: java jar javadoc

我创建了一个我作为JAR文件发布的API。它是专有的,所以我不得不从中删除源文件。

我目前包含一个单独的/ doc文件夹,其中包含Eclipse的export-to-javadoc向导的输出。不错,但我想更进一步。

我想将javadocs作为jar文件分发,可以很容易地将其放入包含我的API的jar文件的未来项目中。我知道我已经看过它用我用过的其他发行版多次这样做了,但我没有任何运气搜索。

最终目标是允许未来的开发人员轻松访问悬停在评论和此类事物上。

谢谢!

2 个答案:

答案 0 :(得分:11)

将包含eclipse生成文档的 doc 文件夹打包为 jar 文件似乎已足够。然后,如果要将该jar用作包含已编译.class文件的实际jar的javadocs,则在Eclipse中为javadoc jar分配“Javadoc in archive”并在其中设置路径存档 doc 。 Eclipse似乎在doc文件夹中查找 index.html package-list 条目。

Setting Javadoc location in Eclipse

使用maven-javadoc-plugin可能是一种简单的方法。请参阅以下链接:

http://www.avajava.com/tutorials/lessons/how-do-i-generate-and-deploy-a-javadoc-jar-file-for-my-project.html

答案 1 :(得分:0)

如果您的最终目标只是让未来的开发人员能够在使用您的类或方法时查看您的javadoc指令,那么在Eclipse中您可以选择在导出jar库时导出java源文件,如图所示下图:

enter image description here

这也允许开发人员在调试时介入并查看代码。