前言
Javadoc 是 Java 專案生成 API 文件的標準工具。本文整理 javadoc 命令的所有選項，供開發者快速查閱。
基本語法
javadoc [options] [packagenames] [sourcefiles] [@files]
核心選項分類
1. 輸出範圍控制
| 選項 | 說明 |
|---|
-overview <file> | 讀取 HTML 格式的概述文件 |
-public | 僅顯示 public 類別與成員 |
-protected | 顯示 protected/public 類別與成員（預設） |
-package | 顯示 package/protected/public 類別與成員 |
-private | 顯示所有類別與成員 |
2. 執行環境與路徑
| 選項 | 說明 |
|---|
-help | 顯示命令列選項 |
-doclet <class> | 透過候選 doclet 產生輸出 |
-docletpath <path> | 指定 doclet 類別檔查找位置 |
-1.1 | 模擬 JDK 1.1 doclet 行為 |
-sourcepath <pathlist> | 指定原始碼檔查找位置 |
-classpath <pathlist> | 指定使用者類別檔查找位置 |
-bootclasspath <pathlist> | 覆蓋啟動類別載入器路徑 |
-extdirs <dirlist> | 覆蓋已安裝擴充套件位置 |
3. 輸出格式與內容
| 選項 | 說明 |
|---|
-verbose | 輸出 Javadoc 執行詳細資訊 |
-locale <name> | 指定 Locale（如 en_US） |
-encoding <name> | 指定原始碼編碼 |
-J<flag> | 直接傳遞旗標給執行環境 |
4. 標準 Doclet 選項
| 選項 | 說明 |
|---|
-d <directory> | 指定輸出目標目錄 |
-use | 建立類別與套件的使用頁面 |
-version | 包含 @version 標籤內容 |
-author | 包含 @author 標籤內容 |
-splitindex | 將索引拆分為每字母一檔 |
-windowtitle <text> | 瀏覽器視窗標題 |
-doctitle <html-code> | 套件索引頁標題 |
-header <html-code> | 每頁頁首文字 |
-footer <html-code> | 每頁頁尾文字 |
-bottom <html-code> | 每頁頁底文字 |
-link <url> | 建立至外部 Javadoc 的連結 |
-linkoffline <url> <url2> | 離線模式連結外部文件 |
-group <name> <p1>:<p2>.. | 概覽頁分組套件 |
-nodeprecated | 不包含 @deprecated 資訊 |
-nodeprecatedlist | 不產生過時列表 |
-notree | 不產生類別階層圖 |
-noindex | 不產生索引 |
-nohelp | 不產生幫助連結 |
-nonavbar | 不產生導覽列 |
-helpfile <file> | 指定幫助連結目標檔案 |
-stylesheetfile <path> | 自訂輸出樣式表 |
-docencoding <name> | 指定輸出編碼 |
常用標籤速查
@see <class>#<method>：建立超連結至相關類別/方法@version <text>：版本資訊@author <name>：作者資訊@param <name> <desc>：方法參數說明@return <desc>：回傳值說明@throws <class> <desc>：拋出例外說明（舊版用 @exception）
使用範例
javadoc -d docs -sourcepath src -subpackages com.myproject -author -version
將 src 下 com.myproject 及子套件的文件產生至 docs 目錄，並包含作者與版本資訊。
