-
javadoc
鎖定
- 中文名
- javadoc
- 外文名
- javadoc
- 提 供
- Sun公司
- 性 質
- 技術
- @author 作者
- 作者標識
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 命令的語法格式如下：
javadoc [options] [packagenames] [sourcefiles] [@files]
其中包括以下幾個元素：
- javadoc：表示要執行的命令。
- [options]：可選參數，用於指定Javadoc命令的選項和標記。
- [packagenames]：可選參數，用於指定要生成文檔的包名稱。
- [sourcefiles]：可選參數，用於指定要生成文檔的源代碼文件。
- [@files]：可選參數，用於指定包含其他選項和標記的文件。
可選參數 | 描述 |
|---|---|
-overview <file> | 從 HTML 文件讀取概覽文檔 |
-public | 僅顯示 public 類和成員 |
-protected | 顯示 protected/public 類和成員 (默認值) |
-package | 顯示 package/protected/public 類和成員 |
-private | 顯示所有類和成員 |
-help | 顯示命令行選項並退出 |
-doclet <class> | 通過替代 doclet 生成輸出 |
-docletpath <path> | 指定查找 doclet 類文件的位置 |
-sourcepath <pathlist> | 指定查找源文件的位置 |
-classpath <pathlist> | 指定查找用户類文件的位置 |
-cp <pathlist> | 指定查找用户類文件的位置 |
-exclude <pkglist> | 指定要排除的程序包列表 |
-subpackages <subpkglist> | 指定要遞歸加載的子程序包 |
-breakiterator | 計算帶有 BreakIterator 的第一個語句 |
-bootclasspath <pathlist> | 覆蓋由引導類加載器所加載的類文件的位置 |
-source <release> | 提供與指定發行版的源兼容性 |
-extdirs <dirlist> | 覆蓋所安裝擴展的位置 |
-verbose | 輸出有關 Javadoc 正在執行的操作的信息 |
-locale <name> | 要使用的區域設置, 例如 en_US 或 en_US_WIN |
-encoding <name> | 源文件編碼名稱 |
-quiet | 不顯示狀態消息 |
-J<flag> | 直接將 <flag> 傳遞到運行時系統 |
-X | 輸出非標準選項的提要 |
-d <directory> | 輸出文件的目標目錄 |
-use | 創建類和程序包用法頁面 |
-version | 包含 @version 段 |
-author | 包含 @author 段 |
-docfilessubdirs | 遞歸複製文檔文件子目錄 |
-splitindex | 將索引分為每個字母對應一個文件 |
-windowtitle <text> | 文檔的瀏覽器窗口標題 |
-doctitle <html-code> | 包含概覽頁面的標題 |
-header <html-code> | 包含每個頁面的頁眉文本 |
-footer <html-code> | 包含每個頁面的頁腳文本 |
-top <html-code> | 包含每個頁面的頂部文本 |
-bottom <html-code> | 包含每個頁面的底部文本 |
-link <url> | 創建指向位於 <url> 的 javadoc 輸出的鏈接 |
-linkoffline <url> <url2> | 利用位於 <url2> 的程序包列表鏈接至位於 <url> 的文檔 |
-excludedocfilessubdir <name1>:.. | 排除具有給定名稱的所有文檔文件子目錄。 |
-group <name> <p1>:<p2>.. | 在概覽頁面中, 將指定的程序包分組 |
-nocomment | 不生成説明和標記, 只生成聲明。 |
-nodeprecated | 不包含 @deprecated 信息 |
-noqualifier <name1>:<name2>:... | 輸出中不包括指定限定符的列表。 |
-nosince | 不包含 @since 信息 |
-notimestamp | 不包含隱藏時間戳 |
-nodeprecatedlist | 不生成已過時的列表 |
-notree | 不生成類分層結構 |
-noindex | 不生成索引 |
-nohelp | 不生成幫助鏈接 |
-nonavbar | 不生成導航欄 |
-serialwarn | 生成有關 @serial 標記的警告 |
-tag <name>:<locations>:<header> | 指定單個參數定製標記 |
-taglet | 要註冊的 Taglet 的全限定名稱 |
-tagletpath | Taglet 的路徑 |
-charset <charset> | 用於跨平台查看生成的文檔的字符集。 |
-helpfile <file> | 包含幫助鏈接所鏈接到的文件 |
-linksource | 以 HTML 格式生成源文件 |
-sourcetab <tab length> | 指定源中每個製表符佔據的空格數 |
-keywords | 使程序包, 類和成員信息附帶 HTML 元標記 |
-stylesheetfile <path> | 用於更改生成文檔的樣式的文件 |
-docencoding <name> | 指定輸出的字符編碼 |
