JavaDoc

JavaDoc支持HTML代碼與標記@。上例中，實現了換行。若是您熟悉HTML語法，便很容易理解。關於@，若是咱們但願javadoc工具生成更詳細的文檔信息，例如爲方法參數、方法返回值等生成詳細的說明信息，則能夠利用javadoc標記，有以下標記：

　　@author 做者名

　　@version 版本標識

　　@parameter 參數及其意義

　　@since 最先使用該方法/類/接口的JDK版本

　　@return 返回值

　　@throws 異常類及拋出條件

　　@deprecated 引發不推薦使用的警告

　　@see reference

　　@override 重寫

　　JavaDoc工具相關用法

　　javadoc命令可對源文件、包來生成API文檔，經常使用選項有以下幾個：

　　javadoc [選項] [軟件包名稱] [源文件] [@file]

　　-overview 讀取 HTML 文件的概述文檔

　　-public 僅顯示公共類和成員

　　-protected 顯示受保護/公共類和成員(默認)

　　-package 顯示軟件包/受保護/公共類和成員

　　-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 直接將 傳遞給運行時系統