JAVA日記：[31]javadoc的用法?

/**

在dos提示符中編譯

生成文檔的代碼：

javadoc -d . -author -version 類名.java

上面的點是代表當前目錄，也可以自己定義一個文件夾。如：myhelp

要想將某類文檔化，該類必須是公共類

//私有的類則不會在文檔中顯示

//公有的和受保護的則能顯示

*/

//javadoc 的用法：

/*

用法: javadoc [options] [packagenames] [sourcefiles] [@files]

-overview 從 HTML 文件讀取概覽文檔

-public 僅顯示 public 類和成員

-protected 顯示 protected/public 類和成員 (默認值)

-package 顯示 package/protected/public 類和成員

-private 顯示所有類和成員

-help 顯示命令行選項並退出

-doclet 通過替代 doclet 生成輸出

-docletpath 指定查找 doclet 類文件的位置

-sourcepath 指定查找源文件的位置

-classpath 指定查找用戶類文件的位置

-exclude 指定要排除的程序包列表

-subpackages 指定要遞歸加載的子程序包

-breakiterator 計算帶有 BreakIterator 的第一個語句

-bootclasspath 覆蓋由引導類加載器所加載的

類文件的位置

-source 提供與指定發行版的源兼容性

-extdirs 覆蓋所安裝擴展的位置

-verbose 輸出有關 Javadoc 正在執行的操作的信息

-locale 要使用的區域設置, 例如 en_US 或 en_US_WIN

-encoding 源文件編碼名稱

-quiet 不顯示狀態消息

-J 直接將 傳遞到運行時系統

-X 輸出非標準選項的提要

通過標準 doclet 提供:

-d 輸出文件的目標目錄

-use 創建類和程序包用法頁面

-version 包含 @version 段

-author 包含 @author 段

-docfilessubdirs 遞歸複製文檔文件子目錄

-splitindex 將索引分為每個字母對應一個文件

-windowtitle 文檔的瀏覽器窗口標題

-doctitle 包含概覽頁面的標題

-header 包含每個頁面的頁眉文本

-footer 包含每個頁面的頁腳文本

-top 包含每個頁面的頂部文本

-bottom 包含每個頁面的底部文本

-link 創建指向位於 的 javadoc 輸出

-linkoffline 利用位於 的程序包列表鏈接至

的文檔

-excludedocfilessubdir :.. 排除具有給定名稱的所有文檔文件子目

-group : .. 在概覽頁面中, 將指定的程序包分組

-nocomment 不生成說明和標記, 只生成聲明。

-nodeprecated 不包含 @deprecated 信息

-noqualifier : :... 輸出中不包括限定符的列表。

-nosince 不包含 @since 信息

-notimestamp 不包含隱藏時間戳

-nodeprecatedlist 不生成已過時的列表

-notree 不生成類分層結構

-noindex 不生成索引

-nohelp 不生成幫助鏈接

-nonavbar 不生成導航欄

-serialwarn 生成有關 @serial 標記的警告

-tag : :

指定單個參數定製標記

-taglet 要註冊的 Taglet 的全限定名稱

-tagletpath Taglet 的路徑

-Xdocrootparent 將文檔註釋中出現的所有後跟 /.. 的

換為

-charset 用於跨平臺查看生成的文檔的字符集。

-helpfile 包含幫助鏈接所鏈接到的文件

-linksource 以 HTML 格式生成源文件

-sourcetab 指定源中每個製表符佔據的空格數

-keywords 使程序包, 類和成員信息附帶 HTML 元

-stylesheetfile 用於更改生成文檔的樣式的文件

-docencoding 輸出編碼名稱

*/

JAVA日記 (共50篇) 上一篇：記事本 下一篇：單例設計模式