在Java程序中Javadoc注釋很重要，但是很多時(shí)候注釋被漏掉，看看項(xiàng)目中的代碼就會(huì)知道。如果你結(jié)對(duì)編程的話，你的伙伴一定會(huì)說，“哥們，這兒注釋丟掉啦，那個(gè)函數(shù)的Javadoc注釋寫的不正確！”。項(xiàng)目中有很多的開發(fā)人員，水平和習(xí)慣都不太一樣，但是對(duì)程序中javadoc注釋來說，這是不能變化的，要規(guī)范起來。如何讓每一個(gè)人都能養(yǎng)成這樣的習(xí)慣呢？下面我們就IntelliJ IDEA使用向大家介紹一下。
IDEA默認(rèn)對(duì)Javadoc的支持非常不錯(cuò)，但是這里我們要引入一個(gè)插件，那就是JavaDoc Sync Plugin，這兩者的結(jié)合將非常完美：JavaDoc Sync Plugin會(huì)提示你添加javadoc注釋及注釋同步，而IDEA本身會(huì)校驗(yàn)javadoc語法，這樣我們的工作就會(huì)簡(jiǎn)單很多。
首先打開Plugin Manager下載并安裝JavaDoc Sync Plugin，重啟IDEA后在設(shè)置面板中選擇“Errors”選項(xiàng)，在“Errors”對(duì)話框中的文本過濾欄輸入javadoc，如下圖。這時(shí)就會(huì)出現(xiàn)和javadoc相關(guān)的設(shè)置選項(xiàng)：
 |
|
這里我們想對(duì)這些設(shè)置項(xiàng)進(jìn)行說明：
- Declaration has javadoc problem：這個(gè)設(shè)置項(xiàng)主要是校驗(yàn)javadoc的語法錯(cuò)誤，如不必要的javadoc注釋，必需的tag丟失等等。這個(gè)設(shè)置項(xiàng)有很多的參數(shù)設(shè)定，你可以參考一下；
- Inconsistent Javadoc主要檢測(cè)javadoc注釋沖突，如接口和實(shí)行類的javadoc不一致；
- Missing Class Javadoc delcaration等提示你應(yīng)該添加注釋。
- Severity最右邊的小按鈕可以設(shè)置錯(cuò)誤級(jí)別顯示效果。
有了這些配置，相信你不在會(huì)忘記添加javadoc注釋啦，因?yàn)镮DEA會(huì)實(shí)時(shí)地給你指出來（高亮、背景等），這是IDEA的代碼審查特性。IDEA同時(shí)提供了快速添加和糾錯(cuò)注釋功能，只需一個(gè)鍵盤操作，就可以完成注釋添加、同步和糾錯(cuò)。
|
|
總結(jié)：通過以上設(shè)置，相信每一個(gè)人都會(huì)養(yǎng)成編寫Javadoc的好習(xí)慣，格式統(tǒng)一。如在版本控制系統(tǒng)管理下，java類的注釋需要@author和@version tag，這樣每個(gè)人都會(huì)加上，對(duì)管理代碼有很大的幫助。IDEA同時(shí)允許你給不同的錯(cuò)誤級(jí)別設(shè)置不同的顯示效果，這樣你文檔中各種問題進(jìn)行標(biāo)識(shí)，方便管理。
|