1. 程式人生 > >用javadoc命令生成api幫助文件

用javadoc命令生成api幫助文件

http://www.eclipse.org/swt下載了最新的swt包。可惜包裡只有原始碼,沒有api幫助文件。如果要學習的話,少了幫助文件哪能行,於是就用javadoc命令自己製作了一個。具體操作如下:

1.準備工作。
將下載到的swt-3.5.2-win32-win32-x86.zip裡的src.zip經兩次解壓到本地目錄。如成功解壓後的目錄結構為:D:\Downloads\swt-3.5.2-win32-win32-x86\src。

2.在上述目錄下新建文字檔案:package.txt,列出所有的包名。
//package.txt的內容如下:

org.eclipse.swt
org.eclipse.swt.accessibility
org.eclipse.swt.awt
org.eclipse.swt.browser
org.eclipse.swt.custom
org.eclipse.swt.dnd
org.eclipse.swt.events
org.eclipse.swt.graphics
org.eclipse.swt.internal
org.eclipse.swt.internal.gdip
org.eclipse.swt.internal.image
org.eclipse.swt.internal.mozilla
org.eclipse.swt.internal.mozilla.init
org.eclipse.swt.internal.ole.win32
org.eclipse.swt.internal.opengl.win32
org.eclipse.swt.internal.theme
org.eclipse.swt.internal.win32
org.eclipse.swt.layout
org.eclipse.swt.ole.win32
org.eclipse.swt.opengl
org.eclipse.swt.printing
org.eclipse.swt.program
org.eclipse.swt.widgets

3.開啟命令列視窗,輸入命令生成api文件。
轉到目錄:D:\Downloads\swt-3.5.2-win32-win32-x86\src,輸入如下命令生成文件。
javadoc -d api @package.txt
注:api表示幫助文件的存放目錄名,@package.txt表示以檔案的形式傳入包名。

4.開啟檔案 \api\index.html。

附錄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修飾符的屬性和方法。

注:本文製作api的方法,適用於所有java開源專案,只要有原始碼就可以。