javadoc

❶ 如何使用javadoc命令生成api文檔，文檔注釋

代碼如下：

[java]view plain

• /**

• *計算器工具類

• *

• *@authorGaoHuanjie

• *@versionV1.0

• */

• publicclassComputerUtil{

• /*

• *加法運算

• *

• *@parama加數a

• *@paramb加數b

• *@return返回兩個整數的和

• */

• publicstaticintadd(inta,intb){

• returna+b;

• }

• /**

• *減法運算

• *

• *@parama被減數

• *@paramb減數

• *@return返回兩個整數的差

• */

• publicstaticintsubtraction(inta,intb){

• returna-b;

• }

• /**

• *乘法運算

• *

• *@parama因數

• *@paramb因數

• *@return返回兩個整數的乘積

• */

• (inta,intb){

• returna*b;

• }

• /**

• *除法運算

• *

• *@parama被除數

• *@paramb除數

• *@return返回兩個整數的商

• */

• intdivision(inta,intb){

• returna/b;

• }

• /**

• *取余運算

• *

• *@parama被除數

• *@paramb除數

• *@return返回兩個整數的相除後的余數

• */

• privateintresial(inta,intb){

• returna%b;

• }

• }

步驟：

①、打開DOS窗口；

②、定位到到該類的源文件所在文件夾；

③、輸入命令：javadoc -d c:help -author -version ComputerUtil.java

說明：-d：其後空一格，用來指定生成的幫助文檔存放的位置；

-author：用來指定生成的幫助文檔必須顯示該類的作者，如果沒有這一命令則生成的幫助文檔將不會顯示作者；

-version：用來指定生成的幫助文檔必須顯示該類的版本，如果沒有這一命令則生成的幫助文檔將不會顯示版本；

④、點擊回車鍵。

結論：

①、Java中多行注釋分為文檔注釋和非文檔注釋，只有文檔注釋所注釋的內容才會出現在幫助文檔中，非文檔注釋所注釋的內容不會出現在幫助文檔中（比如add方法，由於該方法的注釋是非文檔注釋，所以注釋內容沒有生成到幫助文檔中，只出現了該方法的一些信息）；


②、只有被public和protected修飾的方法添加的文檔注釋的注釋內容才能出現在幫助文檔中，所以division方法和resial方法盡管採用了文檔注釋，但注釋內容和方法信息卻沒有出現在幫助文檔中；