java - 应该如何分发库的 Javadoc?

标签 java jar javadoc

我正在编写一个自定义库。它被构建到一个 .jar 文件中。我完全能够生成 javadoc,但我不知道应该如何分发它?

  1. 将其与库放在同一个 .jar 中
  2. 将其放入不同的 .jar 中
  3. 其他方式?

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

  1. 如果我把它放在同一个 .jar 中,我应该在 list 中写一些东西吗?
  2. 如果它在一个单独的 .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/

相关文章:

java - 在 webapp 中创建文件夹并在其中保存图像

java - Linux 中的文件夹或文件 'root' 权限问题

java - 线程中出现异常 "AWT-EventQueue-0"NullPointerException

android - Gradle Javadoc 失败并显示 "error: package ... does not exist"

java - 如何通过容器 View 重新显示和恢复以前添加的 fragment

java - 无法通过 Web 服务以编程方式运行 jar 文件

java - 从 eclipse 运行配置中提取命令行参数

android - gradle 构建 Javadoc 任务失败并显示 'unknown tag: attr'

html - 如何使用元音符号生成 javadoc 文档?

android - 如何在不公开源代码的情况下使用 gradle 创建 Android Library Jar?