javadoc

常用標記

標籤	說明	JDK 1.1 doclet	標準doclet	標籤類型
@author 作者	作者標識	√	√	包、類、接口
@version 版本號	版本號	√	√	包、類、接口
@param 參數名描述	方法的入參名及描述信息，如入參有特別要求，可在此注釋。	√	√	構造函式、方法
@return 描述	對函式返回值的注釋	√	√	方法
@deprecated 過期文本	標識隨著程式版本的提升，當前API已經過期，僅為了保證兼容性依然存在，以此告之開發者不應再用這個API。	√	√	包、類、接口、值域、構造函式、方法
@throws異常類名	構造函式或方法所會拋出的異常。		√	構造函式、方法
@exception 異常類名	同@throws。	√	√	構造函式、方法
@see 引用	查看相關內容，如類、方法、變數等。	√	√	包、類、接口、值域、構造函式、方法
@since 描述文本	API在什麼程式的什麼版本後開發支持。	√	√	包、類、接口、值域、構造函式、方法
{@link包.類#成員標籤}	連結到某個特定的成員對應的文檔中。		√	包、類、接口、值域、構造函式、方法
{@value}	當對常量進行注釋時，如果想將其值包含在文檔中，則通過該標籤來引用常量的值。		√(JDK1.4)	靜態值域

此外還有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}幾個不常用的標籤，由於不常使用，我們不展開敘述，感興趣的讀者可以查看幫助文檔。

Javadoc命令格式如下：

javadoc [選項] [軟體包名稱] [源檔案]

其中選項有：

-overview <檔案> 讀取 HTML 檔案的概述文檔

-public 僅顯示公共類和成員

-protected 顯示受保護/公共類和成員（默認）

-package 顯示軟體包/受保護/公共類和成員

-private 顯示所有類和成員

-help 顯示命令行選項並退出

-doclet <類> 通過替代 doclet 生成輸出

-docletpath <路徑> 指定查找 doclet 類檔案的位置

-sourcepath <路徑列表> 指定查找源檔案的位置

-classpath <路徑列表> 指定查找用戶類檔案的位置

-exclude <軟體包列表> 指定要排除的軟體包的列表

-subpackages <子軟體包列表> 指定要遞歸裝入的子軟體包

-breakiterator 使用 BreakIterator 計算第 1 句

-bootclasspath <路徑列表> 覆蓋引導類載入器所裝入的類檔案的位置

-source <版本> 提供與指定版本的源兼容性

-extdirs <目錄列表> 覆蓋安裝的擴展目錄的位置

-verbose 輸出有關 Javadoc 正在執行的操作的訊息

-locale <名稱> 要使用的語言環境，例如 en_US 或 en_US_WIN