我正在编写一个自定义库。它被构建到一个 .jar 文件中。我完全能够生成 javadoc,但我不知道应该如何分发它?
- 将其与库放在同一个 .jar 中
- 将其放入不同的 .jar 中
- 其他方式?
以及如何将 javadoc 包含在另一个使用我的 lib 的项目中?
- 如果我把它放在同一个 .jar 中,我应该在 list 中写一些东西吗?
- 如果它在一个单独的 .jar 中,将它包含在项目中是否足够?
我使用的是 NetBeans 9.1。
最佳答案
我会在单个存档(zip 或 tar.gz)中包含库 .jar 和文档以及其他内容,例如 README、许可证文件等
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
您可以将压缩的 javadoc 添加到 mylib-1.0.1-javadoc.jar(或 zip)中,而不是存档中扩展的 javadoc/子目录,这两个选项都很常见。
mylib-1.0.1/
├── mylib-1.0.1-javadoc.jar
├── mylib-1.0.1.jar
└── README
关于java - 应该如何分发库的 Javadoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3880757/