JDK tools-javadoc

柯南。道尔發表於2024-03-26

JDK tools-javadoc

JDK工具包-javadoc，從java原始檔生成API文件的HTML頁面

javadoc工具解析一組java原始檔中的宣告和文件註釋，並生成響應的HTML頁面，這些頁面描述(預設情況下)公共和保護屬性的類、介面、建構函式、方法、欄位。你可以使用javadoc工具為一組原始檔生成API文件。

javadoc註釋

javadoc註釋的格式:
    /**
     * test
     * @param text
     * @return
     */

常見的引數:
@author 作者名
@version 版本號
@since 版本號，指明從哪個版本起開始有這個方法
@param 方法的引數
@return 標明返回值型別，一般用於方法註釋
@exception 可能丟擲異常的說明
@throws 可能丟擲異常的說明

命令列生成javadoc文件

javadoc [options] [packagenames] [sourcefiles] [@files]
options:選項
指定命令列選項，以空格分隔
常用的選項:
-encoding
對javadoc工具讀取的檔案進行編碼
eg:
-encoding UTF-8

-charset
對javadoc工具寫入的檔案進行編碼
eg:
-charset UTF-8

-d
指定生成的HTML輸出路徑

packagename:包名
指定要記錄的包的名稱，以空格分隔。例如 java.lang，java.awt。如果還想記錄子包，使用-subpackages選項來指定包。
預設情況下，javadoc在當前目錄和子目錄中查詢指定的包。使用-sourcepath選項指定要在其中查詢包的目錄列表。

sourcefiles:原始檔
指定要記錄的java原始檔的名稱，以空格分隔。例如：Class.java Button.java。預設情況下，javadoc在當前目錄中查詢指定的類。但是你可以指定類檔案的完整路徑並使用萬用字元。例如/home/src/java/awt/Test*.java。還可以指定相對與當前目錄的路徑。

@files:檔名
指定包含javadoc工具選項列表、包名、任意順序的原始檔名的檔名。

eg: 指定Test.java類生成javadoc文件，輸出到doc資料夾下
javadoc -encoding UTF-8 -charset UTF-8 -d doc Test.java