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

2022-09-03 15:27:54

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

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

我想将javadocs作为jar文件分发,该文件可以很容易地放入未来的项目中,其中包括我的API的jar文件。我知道我已经多次看到它在我使用过的其他发行版中以这种方式完成,但我没有运气搜索。

最终目标是允许未来的开发人员轻松访问将鼠标悬停在评论和类似性质的内容上。

谢谢!


答案 1

似乎将包含 eclipse 生成的文档的 doc 文件夹打包为 jar 文件就足够了。然后,如果你想使用这个jar作为包含已编译.class文件的实际jar的javadocs,你可以在Eclipse中分配带有“Javadoc in archive”的javadoc jar,并将Path in archive设置为doc。Eclipse 似乎在 doc 文件夹中查找索引.html包列表条目。

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


答案 2

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

enter image description here

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


推荐