javadoc技術,是從源代碼中抽取類,方法,成員等文檔註釋形成一個與源代碼配套的API幫助文檔,用一套特定的標籤做註釋,在編程結束後,通過javadoc.exe生成開發文檔。
常用的3種註釋語句:
//用於單行註釋
/*......*/用於多行註釋,不能嵌套
/**.......*/用於支持javadoc的特有的文檔註釋語句
javadoc能從java源文件中讀取第三種方式的註釋並識別一些特殊的變量
@auth 作者信息
@version 版本信息
@parameter 參數名和意義
@since 參數名和意義
@return 返回值
@throws 異常類和拋出條件
@deprecated 引起不推薦使用的警告
@see 交叉參數
執行過程
同編譯java文件一樣
用javadoc TestJavaDoc.java
即可生成html的說明文檔。
Javadoc的格式如下:
javadoc 選項|軟件包名|源文件|@file
@file指包含文件,爲了簡化操作,可以把需要的軟件包名和源文件放在一個文件中
javadoc —d mydoc test.1 test.2
可以用一個名稱爲myfile.txt的文件內容:
mydoc test.1
test.2
然後執行:javadoc —d mydoc @myfile.txt
javadoc工具的詳細說明可以用javadoc -help命令