MyEclipse生成javadoc文檔

一。右鍵項目,選擇Exporthtml


二。選擇java下面的javadocjava


三。create javadoc for members with visibility解釋
private 全部類和成員都生成node

package除了前邊帶private的私有類和成員,其餘都生成。瀏覽器

protected 前邊帶protected和public的都生成。less

public 前邊public的生成。(默認)ui

四。選好路徑編碼


五。選擇引用文件和項目以生成連接。(全選就行,也就是下圖的Select All,警告忽略)url


六。Extra javadoc options填上(-encoding 編碼名 -charset 編碼名,項目是UTF-8編碼的就用下圖方式),JRE source compatibility 個人jdk是1.7的因此我選的1.7.而後點Finishspa


七。在cmd下 運行javadoc能夠顯示出全部的命令選項,能夠填在Extra javadoc options上,下面列出來。.net


用法: 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> 的程序包列表連接至位於 <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 的路徑
-Xdocrootparent <url>             將文檔註釋中出現的全部後跟 /.. 的 @docRoot 替換爲 <url>
-charset <charset>                用於跨平臺查看生成的文檔的字符集。
-helpfile <file>                  包含幫助連接所連接到的文件
-linksource                       以 HTML 格式生成源文件
-sourcetab <tab length>           指定源中每一個製表符佔據的空格數
-keywords                         使程序包, 類和成員信息附帶 HTML 元標記
-stylesheetfile <path>            用於更改生成文檔的樣式的文件
-docencoding <name>               輸出編碼名稱

生成doc的效果:

相關文章
相關標籤/搜索