2019獨(dú)角獸企業(yè)重金招聘Python工程師標(biāo)準(zhǔn)>>>

一、Javadoc介紹

Javadoc其實(shí)平常我們都會見到，JAVASE的API文檔就是一個javadoc，很明顯，Javadoc的目的是為了能夠讓外部客戶理解我們的代碼并使用我們對外的接口。

記住：編寫Javadoc的時候只需要對外的接口即可，不需要內(nèi)部的接口也編寫Javadoc注釋;

二、Javadoc注釋

一般我們的注釋形式是：

(1) //

(2) /* ? ? */

而Javadoc注釋的形式是：

/**?

?*??

?*?@return ?

?*/??

注意：必須以/**開頭；

三、Eclipse生成Javadoc文檔

1.編寫Javadoc注釋

在Eclipse中，如果在某個方法前面輸入/**后回車，則會自動生成Javadoc注釋的格式，比如：

[public?void?setAge(int?age)?{??

????this.age?=?age;??

}??

在以上代碼的上一行輸入/** 后回車，則會生成如下形式的注釋：

/**?

?*??

?*?@param?age??

?*/??

public?void?setAge(int?age)?{??

????this.age?=?age;??

}??

2.生成Javadoc注釋

如果想生成某個文件或工程的Javadoc文檔，則右擊后點(diǎn)擊Export，然后選擇javadoc，即可生成Javadoc；

（可能會出現(xiàn)編碼問題，比如一個瀏覽器不會出現(xiàn)亂碼，而一個瀏覽器會出現(xiàn)亂碼，比如我生成的中文文檔，safari是亂碼，IE不是亂碼）;

四、示例

代碼如下：

?*?創(chuàng)建Person對象的另一種方式?

?*?@param?name?姓名?

?*?@param?age?年齡?

?*?@return?Person對象?

?*/??

public?static?Person?getInstance(String?name,int?age){??

????return?new?Person(name,age);??

}??

則生成的形式如下：

轉(zhuǎn)載于:https://my.oschina.net/u/1582930/blog/491630

超強(qiáng)干貨來襲 云風(fēng)專訪：近40年碼齡，通宵達(dá)旦的技術(shù)人生

總結(jié)

以上是生活随笔為你收集整理的Java生成javadoc的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。