Javadoc API文件產生器
Javadoc程序讀取一個Java類文件並自動創建一組Html文件,這些HTML 文件描述了Java類文件的類、變量、成員函數,所有Java類庫的APIHTML 文件都可以由此程序創建。Javadoc把軟件包名或源文件列表當做一個變量。
Javadoc依靠以@打頭的備注標記來創建HTML文件,下面就是標注的列表,它們被Javadoc用於在HTML 文件中創建鏈接。
選項 功能
@see classname 此標注在類列表中增加一個到所提供類的"See Also"條目。
@see classname # methodname 此標注創建一個到特定的成員函數的"See Also"條目。
@version text 此標注在HTML文件中加入一個版本信息條目
@author text 此標注在HTML文件中加入一個作者信息條目
@param name description 此標注用成員函數備注來描述一個成員函數所帶變量
@return description 此標注用成員函數備注來描述返回值
@exception classname 此標注用成員函數備注來連接成員函數產生的異常出口
-classpath path 此命令行指定尋找Java文件的目錄
-d Directory 此命令行指定用來放入最終HTML文件十分有用。