如何为 javadocs 创建一个可分发的 jar？答案

【问题标题】：How do I create a jar distributable for javadocs?如何为 javadocs 创建一个可分发的 jar？
【发布时间】：2011-10-30 21:37:19
【问题描述】：

我创建了一个以 JAR 文件形式发布的 API。它是专有的，所以我不得不从中剥离源文件。

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

我想将 javadocs 作为 jar 文件分发，该文件可以轻松放入未来的项目中，其中包括我的 API 的 jar 文件。我知道在我使用过的其他发行版中，我已经多次看到过这种方式，但我没有找到任何运气。

最终目标是让未来的开发人员能够轻松地将鼠标悬停在 cmets 和类似性质的东西上。

谢谢！

【问题讨论】：

至少对于您问题的第二部分...这里是有关如何将 JavaDocs 放入 Eclipse stackoverflow.com/a/11579339/356895 的详细说明

标签： java jar javadoc

【解决方案1】：

似乎将包含 eclipse 生成的文档的 doc 文件夹打包为 jar 文件就足够了。然后，如果您想将该 jar 用作包含已编译 .class 文件的实际 jar 的 javadoc，请在 Eclipse 中为 javadoc jar 分配 "Javadoc in archive" 并在其中设置 Path归档为文档。 Eclipse 似乎在 doc 文件夹中查找 index.html 和 package-list 条目。

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

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

【讨论】：

感谢您的推荐。我实际上偶然发现了 javadoc maven 插件，虽然我不想将 maven 引入到非 maven 项目中。我将更多地研究插件实际在做什么，这可能有助于我理解如何在没有 maven 的情况下生成 javadoc jar。感谢您的帮助，我会跟进任何其他发现。
@Batman0730 我已经编辑了答案。你能试试我描述的方法吗？
我认为这消除了我一直以来的误解。您不能只是将这些 javadoc.jar 文件放到项目中，然后神奇地将 cmets 附加到代码中。您必须手动将 javadocs 附加到它们的库中，即使它们是 .jar 格式。我以前从未测试过它，所以我的假设一直都是错误的。感谢您的帮助。

【解决方案2】：

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

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

【讨论】：