Javadoc標(biāo)記
介紹常用的javadoc，全部javadoc可以見官網(wǎng)的 javadoc弦撩。
@author
用于標(biāo)記代碼的作者步咪，可以用a標(biāo)簽將個(gè)人博客或個(gè)人郵箱與自己的姓名綁定。
另外益楼，在 JDK 代碼中我們經(jīng)郴看到 @author unascribed，意思是：“該代碼第一原作者不是我感凤，但我實(shí)在也不知道是誰悯周，就記作無名氏吧”（這是多么嚴(yán)肅的一種版權(quán)意識啊）陪竿。
@value
可以用于生成被標(biāo)記的常量字段的值禽翼。
{@inheritDoc}
繼承父類的文檔（包括@return @param @throws），子類可以再加入自己的注釋族跛。其實(shí)在不寫 {@inheritDoc} 的情況下也存在文檔注釋的繼承闰挡。
{@link}、{@linkplain}
link 和 linkplain 的實(shí)參都是package.class#member label礁哄。唯一的不同就是因?yàn)樽煮w不同长酗，如果 label 是個(gè)純文本，那就使用 linkplain 吧桐绒。
@since
根據(jù)官方文檔解釋夺脾，@since 表達(dá)的是被標(biāo)記元素是哪個(gè)發(fā)布版本引入的之拨。
@version
提到了 @since 就自然會(huì)聯(lián)想到 @version，因?yàn)樗鼈兊膶?shí)參都是版本相關(guān)的咧叭。@version 要表達(dá)的是被標(biāo)記元素自己的版本（注意對比 @since）敦锌，也就是說這個(gè)版本只要代碼改過就應(yīng)該發(fā)生變化，而 @since 是不會(huì)變的佳簸。
@exception乙墙、@throws
它們完全是同義詞，用于標(biāo)記要拋出的異常生均。
@param @return @throws
標(biāo)記參數(shù)听想，返回值，異常马胧。
@deprecated
標(biāo)記過時(shí)的方法或類汉买。
HTML標(biāo)記
pre
可以使用<pre></pre>來顯示代碼原有的樣子，比javadoc的{@code }塊好用多了佩脊，后者根本不能保證換行蛙粘、縮進(jìn)等，適合用于文中嵌入的代碼威彰。
當(dāng)然還有一些常見的如 <b></b>出牧、<p></p>、<br>歇盼、<h#></h#> 可以用于美化格式舔痕，就不一一指出了，反正javadoc都是支持的嘛豹缀。
其他
寫中文注釋的建議
- 使用中文的句號作為文檔注釋的結(jié)尾伯复。
- 在中文中的英文和數(shù)字符號前后加入空格。
包注釋
推薦使用 package-info.java 的方式邢笙，因?yàn)檫@樣可以使用注解啸如。
RESTful風(fēng)格注解
如果需要為RESTful風(fēng)格的接口書寫文檔的話，推薦使用apiDoc的規(guī)范氮惯，也可以生成html文檔叮雳，著實(shí)好用，強(qiáng)力推薦??
