JavaDoc的生成規則
阿新 • • 發佈:2019-02-13
用法: javadoc [options] [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> 指定查詢使用者類檔案的位置
-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 輸出非標準選項的提要
通過標準 doclet 提供:
-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> 的程式包列表連結至位於
的文件
-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 的路徑
-Xdocrootparent <url> 將文件註釋中出現的所有後跟 /.. 的 @doc
換為 <url>
-charset <charset> 用於跨平臺檢視生成的文件的字符集。
-helpfile <file> 包含幫助連結所連結到的檔案
-linksource 以 HTML 格式生成原始檔
-sourcetab <tab length> 指定源中每個製表符佔據的空格數
-keywords 使程式包, 類和成員資訊附帶 HTML 元標記
-stylesheetfile <path> 用於更改生成文件的樣式的檔案
-overview <file> 從 HTML 檔案讀取概覽文件
-public 僅顯示 public 類和成員
-protected 顯示 protected/public 類和成員 (預設值)
-package 顯示 package/protected/public 類和成員
-private 顯示所有類和成員
-help 顯示命令列選項並退出
-doclet <class> 通過替代 doclet 生成輸出
-docletpath <path> 指定查詢 doclet 類檔案的位置
-sourcepath <pathlist> 指定查詢原始檔的位置
-classpath <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 輸出非標準選項的提要
通過標準 doclet 提供:
-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> 的程式包列表連結至位於
的文件
-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 的路徑
-Xdocrootparent <url> 將文件註釋中出現的所有後跟 /.. 的 @doc
換為 <url>
-charset <charset> 用於跨平臺檢視生成的文件的字符集。
-helpfile <file> 包含幫助連結所連結到的檔案
-linksource 以 HTML 格式生成原始檔
-sourcetab <tab length> 指定源中每個製表符佔據的空格數
-keywords 使程式包, 類和成員資訊附帶 HTML 元標記
-stylesheetfile <path> 用於更改生成文件的樣式的檔案
-docencoding <name> 輸出編碼名稱