MyEclipse中怎么生成javadoc文檔

這篇文章給大家介紹MyEclipse中怎么生成javadoc文檔，內(nèi)容非常詳細(xì)，感興趣的小伙伴們可以參考借鑒，希望對(duì)大家能有所幫助。

一。右鍵項(xiàng)目，選擇Export

二。選擇java下面的javadoc

三。create javadoc for members with visibility解釋
private 所有類和成員都生成

package除了前邊帶private的私有類和成員，其他都生成。

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

public 前邊public的生成。（默認(rèn)）

四。選好路徑

五。選擇引用文件和項(xiàng)目以生成鏈接。（全選就行，也就是下圖的Select All，警告忽略）

六。Extra javadoc options填上（-encoding 編碼名 -charset 編碼名，項(xiàng)目是UTF-8編碼的就用下圖方式），JRE source compatibility 我的jdk是1.7的所以我選的1.7.然后點(diǎn)Finish

七。在cmd下 運(yùn)行javadoc可以顯示出所有的命令選項(xiàng)，可以填在Extra javadoc options上，下面列出來(lái)。

用法: javadoc [options] [packagenames] [sourcefiles] [@files]
-overview <file>          從 HTML 文件讀取概覽文檔
-public                   僅顯示 public 類和成員
-protected                顯示 protected/public 類和成員 (默認(rèn)值)
-package                  顯示 package/protected/public 類和成員
-private                  顯示所有類和成員
-help                     顯示命令行選項(xiàng)并退出
-doclet <class>            通過替代 doclet 生成輸出
-docletpath <path>        指定查找 doclet 類文件的位置
-sourcepath <pathlist>    指定查找源文件的位置
-classpath <pathlist>     指定查找用戶類文件的位置
-exclude <pkglist>        指定要排除的程序包列表
-subpackages <subpkglist> 指定要遞歸加載的子程序包
-breakiterator            計(jì)算帶有 BreakIterator 的第一個(gè)語(yǔ)句
-bootclasspath <pathlist> 覆蓋由引導(dǎo)類加載器所加載的
                           類文件的位置
-source <release>         提供與指定發(fā)行版的源兼容性
-extdirs <dirlist>        覆蓋所安裝擴(kuò)展的位置
-verbose                  輸出有關(guān) Javadoc 正在執(zhí)行的操作的信息
-locale <name>            要使用的區(qū)域設(shè)置, 例如 en_US 或 en_US_WIN
-encoding <name>          源文件編碼名稱
-quiet                    不顯示狀態(tài)消息
-J<flag>                  直接將 <flag> 傳遞到運(yùn)行時(shí)系統(tǒng)
-X                        輸出非標(biāo)準(zhǔn)選項(xiàng)的提要

通過標(biāo)準(zhǔn) doclet 提供:
-d <directory>                    輸出文件的目標(biāo)目錄
-use                              創(chuàng)建類和程序包用法頁(yè)面
-version                          包含 @version 段
-author                           包含 @author 段
-docfilessubdirs                  遞歸復(fù)制文檔文件子目錄
-splitindex                       將索引分為每個(gè)字母對(duì)應(yīng)一個(gè)文件
-windowtitle <text>               文檔的瀏覽器窗口標(biāo)題
-doctitle <html-code>             包含概覽頁(yè)面的標(biāo)題
-header <html-code>               包含每個(gè)頁(yè)面的頁(yè)眉文本
-footer <html-code>               包含每個(gè)頁(yè)面的頁(yè)腳文本
-top    <html-code>               包含每個(gè)頁(yè)面的頂部文本
-bottom <html-code>               包含每個(gè)頁(yè)面的底部文本
-link <url>                       創(chuàng)建指向位于 <url> 的 javadoc 輸出的鏈接
-linkoffline <url> <url2>         利用位于 <url2> 的程序包列表鏈接至位于 <url> 的文檔
-excludedocfilessubdir <name1>:.. 排除具有給定名稱的所有文檔文件子目錄。
-group <name> <p1>:<p2>..         在概覽頁(yè)面中, 將指定的程序包分組
-nocomment                        不生成說明和標(biāo)記, 只生成聲明。
-nodeprecated                     不包含 @deprecated 信息
-noqualifier <name1>:<name2>:...  輸出中不包括限定符的列表。
-nosince                          不包含 @since 信息
-notimestamp                      不包含隱藏時(shí)間戳
-nodeprecatedlist                 不生成已過時(shí)的列表
-notree                           不生成類分層結(jié)構(gòu)
-noindex                          不生成索引
-nohelp                           不生成幫助鏈接
-nonavbar                         不生成導(dǎo)航欄
-serialwarn                       生成有關(guān) @serial 標(biāo)記的警告
-tag <name>:<locations>:<header>  指定單個(gè)參數(shù)定制標(biāo)記
-taglet                           要注冊(cè)的 Taglet 的全限定名稱
-tagletpath                       Taglet 的路徑
-Xdocrootparent <url>             將文檔注釋中出現(xiàn)的所有后跟 /.. 的 @docRoot 替換為 <url>
-charset <charset>                用于跨平臺(tái)查看生成的文檔的字符集。
-helpfile <file>                  包含幫助鏈接所鏈接到的文件
-linksource                       以 HTML 格式生成源文件
-sourcetab <tab length>           指定源中每個(gè)制表符占據(jù)的空格數(shù)
-keywords                         使程序包, 類和成員信息附帶 HTML 元標(biāo)記
-stylesheetfile <path>            用于更改生成文檔的樣式的文件
-docencoding <name>               輸出編碼名稱

生成doc的效果：

關(guān)于MyEclipse中怎么生成javadoc文檔就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò)，可以把它分享出去讓更多的人看到。