從命令列構建 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]