如何为图书馆分发Javadoc？

我正在写一个自定义库。 它构建成.jar存档。 我完全能够生成javadoc，但我不知道应该如何分发它？

1. 将它放在与库相同的.jar中
2. 把它放在一个不同的.jar中
3. 还有其他方法吗？

以及如何将javadoc包含在另一个使用我的lib的项目中？

1. 如果我把它放在同一个.jar中，我应该在清单中写一些东西吗？
2. 如果它在一个单独的.jar中，是否足够包含在项目中？

我正在使用NetBeans 9.1。

Answer 1

我将库.jar和文档以及其他内容（如README，许可证文件等）包含在单个存档中（zip或tar.gz）

mylib-1.0.1.tar.gz，其中包含：

mylib-1.0.1/ ├── javadoc │  └── index.html (and all other javadoc files under here) ├── mylib-1.0.1.jar └── README 

您可以在mylib-1.0.1-javadoc.jar（或zip）中添加压缩的javadoc，而不是存档中扩展的javadoc / sub目录，这两个选项都很常见。

 mylib-1.0.1/ ├── mylib-1.0.1-javadoc.jar ├── mylib-1.0.1.jar └── README 

Answer 2

将JavaDocs保存在单独的存档中是一种通用做法。 甚至更常见的是，在名为“docs”的目录中。 你不要不必要用html和js文件来膨胀你的库的档案。

为什么要在项目中包含生成的JavaDocs [html + js]？ 只要源代码JavaDoc注释到位，使用您的库的人就可以通过简单地将鼠标hover在任何现代IDE的鼠标上来查看它们。

更新
根据下面的nanda的评论，我检查了同样的，他是正确的。 在我的项目中，我实际上将Javadocs从’doc’文件夹附加到存档，以便能够在鼠标hover时查看它们。

Answer 3

另一种方式：对我而言，这是最好的选择:(添加到build.xml。我在NetBeans IDE 7.0和7.2.1上测试过它）（ 在Netbeans中自动生成源代码和doc jar时发现它）

这将创建四个jar子，一个用于应用程序，一个用于源，一个用于测试，一个用于javadoc。