打開命令行窗口,輸入命令生成api文檔。
轉到目錄:D:\Downloads\swt-3.5.2-win32-win32-x86\src,輸入如下命令生成文檔。
javadoc -d api @package.txt
注:api表示幫助文檔的存放目錄名,@package.txt表示以文件的形式傳入包名。
附錄1:javadoc命令語法。
在命令行輸入javadoc回車就會出現如下的幫助信息:
javadoc用法:javadoc [選項] [軟件包名稱] [源文件] [@file]
-overview <文件> 讀取 HTML 文件的概述文檔
-public 僅顯示公共類和成員 //帶有public修飾符
-protected 顯示受保護/公共類和成員(默認) //帶有protected、public修飾符
-package 顯示軟件包/受保護/公共類和成員 //不帶修飾符,或帶有protected、public修飾符
-private 顯示所有類和成員 //不帶修飾符,或帶有任何修飾符
-help 顯示命令行選項並退出
-doclet <類> 通過替代 doclet 生成輸出
-docletpath <路徑> 指定查找 doclet 類文件的位置
-sourcepath <路徑列表> 指定查找源文件的位置
-classpath <路徑列表> 指定查找用戶類文件的位置
-exclude <軟件包列表> 指定要排除的軟件包的列表
-subpackages <子軟件包列表> 指定要遞歸裝入的子軟件包
-breakiterator 使用 BreakIterator 計算第 1 句
-bootclasspath <路徑列表> 覆蓋引導類加載器所裝入的類文件的位置
-source <版本> 提供與指定版本的源兼容性
-extdirs <目錄列表> 覆蓋安裝的擴展目錄的位置
-verbose 輸出有關 Javadoc 正在執行的操作的消息
-locale <名稱> 要使用的語言環境,例如 en_US 或 en_US_WIN
-encoding <名稱> 源文件編碼名稱
-quiet 不顯示狀態消息
-J<標誌> 直接將 <標誌> 傳遞給運行時系統
通過標準 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> 的包列表鏈接至位於 <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> 輸出編碼名稱
附錄2:常用命令舉例。
javadoc -d api org/eclipse/swt/SWT.java //處理單個源文件
javadoc -d api org.eclipse.swt //處理單個包
javadoc -d api org.eclipse.swt org.eclipse.swt.widgets //處理多個包,如果處理的包較少,可以採用直接輸入的方法
javadoc -private -d api @package.txt //處理多個包。生成最完整的幫助文檔,包括帶有private修飾符的屬性和方法。