从命令行构建 Javadocs

许多 IDE 都支持自动从 Javadocs 生成 HTML; 一些构建工具( 例如 MavenGradle )也有可以处理 HTML 创建的插件。

但是,生成 Javadoc HTML 不需要这些工具; 这可以使用命令行 javadoc 工具完成。

该工具的最基本用法是:

javadoc JavaFile.java

这将从 JavaFile.java 中的 Javadoc 注释生成 HTML。

更实际地使用命令行工具,它将递归读取 [source-directory] 中的所有 java 文件,为 [package.name] 和所有子包创建文档,并将生成的 HTML 放在 [docs-directory] 中:

javadoc -d [docs-directory] -subpackages -sourcepath [source-directory] [package.name]