一、類注釋

打開 IDEA 的?Settings，點擊?Editor-->File and Code Templates，點擊右邊?File?選項卡下面的Class，在其中添加圖中紅框內(nèi)的內(nèi)容：/**
?* @author jitwxs
?* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
?*/注 意

在我提供的示例模板中，說明了作者和時間，IDEA 支持的所有的模板參數(shù)在下方的?Description?中被列出來。保存后，當(dāng)你創(chuàng)建一個新的類的時候就會自動添加類注釋。如果你想對接口也生效，同時配置上圖中的Interface?項即可。

二、方法注釋不同于目前網(wǎng)絡(luò)上互相復(fù)制粘貼的方法注釋教程，本文將實現(xiàn)以下功能：

• 根據(jù)形參數(shù)目自動生成?@param?注解

• 根據(jù)方法是否有返回值智能生成?@Return?注解

相較于類模板，為方法添加注釋模板就較為復(fù)雜，首先在?Settings?中點擊?Editor-->Live Templates。點擊最右邊的?+，首先選擇?2. Template Group...?來創(chuàng)建一個模板分組：

在彈出的對話框中填寫分組名，我這里叫做 userDefine：

然后選中剛剛創(chuàng)建的模板分組?userDefine，然后點擊?+，選擇?1. Live Template：

此時就會創(chuàng)建了一個空的模板，我們修改該模板的?Abbreviation、Description?和?Template text。需要注意的是，Abbreviation?必須為?*，最后檢查下?Expand with?的值是否為 Enter 鍵。

上圖中·?Template text?內(nèi)容如下，請直接復(fù)制進去，需要注意首行沒有?/，且?\*?是頂格的。*
?*?
?* @author jitwxs
?* @date $date$ $time$$param$ $return$
?*/注意到右下角的?No applicable contexts yet?了嗎，這說明此時這個模板還沒有指定應(yīng)用的語言：

點擊?Define，在彈框中勾選Java，表示將該模板應(yīng)用于所有的 Java 類型文件。

還記得我們配置?Template text?時里面包含了類似于?$date$?這樣的參數(shù)，此時 IDEA 還不認(rèn)識這些參數(shù)是啥玩意，下面我們對這些參數(shù)進行方法映射，讓 IDEA 能夠明白這些參數(shù)的含義。點擊?Edit variables?按鈕：

為每一個參數(shù)設(shè)置相對應(yīng)的?Expression：

需要注意的是，date?和?time?的?Expression?使用的是 IDEA 內(nèi)置的函數(shù)，直接使用下拉框選擇就可以了，而?param?這個參數(shù) IDEA 默認(rèn)的實現(xiàn)很差，因此我們需要手動實現(xiàn)，代碼如下：groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())另外?return?這個參數(shù)我也自己實現(xiàn)了下，代碼如下：groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

注：你還注意到我并沒有勾選了?Skip if defined?屬性，它的意思是如果在生成注釋時候如果這一項被定義了，那么鼠標(biāo)光標(biāo)就會直接跳過它。我并不需要這個功能，因此有被勾選該屬性。

點擊 OK 保存設(shè)置，大功告成！

三、檢驗成果3.1 類注釋類注釋只有在新建類時才會自動生成，效果如下：

3.2 方法注釋

將演示以下幾種情況：

1. 無形參

2. 單個形參

3. 多個形參

4. 無返回值

5. 有返回值

四、Q & A

（1）為什么模板的?Abbreviation?一定要叫?\*?？Expand with?要保證是 Enter 鍵？答：因為 IDEA 模板的生成邏輯是?模板名 + 生成鍵，當(dāng)生成鍵是 Enter 時，我們輸入?* + Enter?就能夠觸發(fā)模板。這也同時說明了為什么注釋模板首行是一個?*?了，因為當(dāng)我們先輸入?/*，然后輸入?* + Enter，觸發(fā)模板，首行正好拼成了?/**，符合 Javadoc 的規(guī)范。

（2）注釋模板中為什么有一行空的?\*？答：因為我習(xí)慣在這一行寫方法說明，所以就預(yù)留了一行空的寫，你也可以把它刪掉。

（3）注釋模板中?$time$$param$?這兩個明明不相干的東西為什么緊貼在一起？答：首先網(wǎng)上提供的大部分 param 生成函數(shù)在無參情況下仍然會生成一行空的?@param，因此我對param 函數(shù)的代碼進行修改，使得在無參情況下不生成?@param，但是這就要求?$param$?要和別人處在同一行中，不然沒法處理退格。

（4）為什么 return 參數(shù)不使用?methodReturnType()， 而要自己實現(xiàn)？答：methodReturnType()?在無返回值的情況下會返回 void，這并沒有什么意義，因此我對 methodReturnType() 返回值進行了處理，僅在有返回值時才生成。

（5）為什么?$return$?不是單獨一行？答：因為當(dāng)?methodReturnType()?返回 null 時，無法處理退格問題，原因同第三點。