IDEA 注釋模板，這樣配置才夠逼格！

程序員的成長之路

互聯(lián)網(wǎng)/程序員/技術(shù)/資料共享 

閱讀本文大概需要 3.5 分鐘。

來自：https://jitwxs.cn/4135e0a9.html

一、類注釋

打開 IDEA 的 Settings，點(diǎn)擊 Editor-->File and Code Templates，點(diǎn)擊右邊 File 選項(xiàng)卡下面的 Class，在其中添加圖中紅框內(nèi)的內(nèi)容：

/**
 * @author jitwxs
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

在我提供的示例模板中，說明了作者和時(shí)間，IDEA 支持的所有的模板參數(shù)在下方的 Description 中被列出來。

保存后，當(dāng)你創(chuàng)建一個(gè)新的類的時(shí)候就會(huì)自動(dòng)添加類注釋。如果你想對(duì)接口也生效，同時(shí)配置上圖中的 Interface 項(xiàng)即可。

二、方法注釋

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

• 根據(jù)形參數(shù)目自動(dòng)生成 @param 注解
• 根據(jù)方法是否有返回值智能生成 @Return 注解

相較于類模板，為方法添加注釋模板就較為復(fù)雜，首先在 Settings 中點(diǎn)擊 Editor-->Live Templates。

點(diǎn)擊最右邊的 +，首先選擇 2. Template Group... 來創(chuàng)建一個(gè)模板分組：

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

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

此時(shí)就會(huì)創(chuàng)建了一個(gè)空的模板，我們修改該模板的 Abbreviation、Description 和 Template text。

需要注意的是，Abbreviation 必須為 *，最后檢查下 Expand with 的值是否為 Enter 鍵。

上圖中Template text 內(nèi)容如下，請直接復(fù)制進(jìn)去，需要注意首行沒有 /，且 * 是頂格的。

*
 * 
 * @author jitwxs
 * @date $date$ $time$$param$ $return$
 */

注意到右下角的 No applicable contexts yet 了嗎，這說明此時(shí)這個(gè)模板還沒有指定應(yīng)用的語言：

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

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

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

需要注意的是，date 和 time 的 Expression 使用的是 IDEA 內(nèi)置的函數(shù)，直接使用下拉框選擇就可以了，而 param 這個(gè)參數(shù) IDEA 默認(rèn)的實(shí)現(xiàn)很差，因此我們需要手動(dòng)實(shí)現(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 這個(gè)參數(shù)我也自己實(shí)現(xiàn)了下，代碼如下：

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

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

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

三、檢驗(yàn)成果

3.1 類注釋

類注釋只有在新建類時(shí)才會(huì)自動(dòng)生成，效果如下：

3.2 方法注釋

將演示以下幾種情況：

• 無形參
• 單個(gè)形參
• 多個(gè)形參
• 無返回值
• 有返回值

四、Q & A

（1）為什么模板的 Abbreviation 一定要叫 * ？Expand with 要保證是 Enter 鍵？

答：因?yàn)?IDEA 模板的生成邏輯是 模板名 + 生成鍵，當(dāng)生成鍵是 Enter 時(shí)，我們輸入 * + Enter 就能夠觸發(fā)模板。

這也同時(shí)說明了為什么注釋模板首行是一個(gè) * 了，因?yàn)楫?dāng)我們先輸入 /*，然后輸入 * + Enter，觸發(fā)模板，首行正好拼成了 /**，符合 Javadoc 的規(guī)范。

（2）注釋模板中為什么有一行空的*？

答：因?yàn)槲伊?xí)慣在這一行寫方法說明，所以就預(yù)留了一行空的寫，你也可以把它刪掉。

（3）注釋模板中 $time$$param$ 這兩個(gè)明明不相干的東西為什么緊貼在一起？

答：首先網(wǎng)上提供的大部分 param 生成函數(shù)在無參情況下仍然會(huì)生成一行空的 @param，因此我對(duì)param 函數(shù)的代碼進(jìn)行修改，使得在無參情況下不生成 @param，但是這就要求 $param$ 要和別人處在同一行中，不然沒法處理退格。

（4）為什么 return 參數(shù)不使用 methodReturnType()， 而要自己實(shí)現(xiàn)？

答：methodReturnType() 在無返回值的情況下會(huì)返回 void，這并沒有什么意義，因此我對(duì) methodReturnType() 返回值進(jìn)行了處理，僅在有返回值時(shí)才生成。

（5）為什么 $return$ 不是單獨(dú)一行？

答：因?yàn)楫?dāng) methodReturnType() 返回 null 時(shí)，無法處理退格問題，原因同第三點(diǎn)。

<END>

推薦閱讀：

騰訊知名軟件全線下架，網(wǎng)友一片唏噓

Spring Boot 一個(gè)接口同時(shí)支持 form 表單、form-data、json 的優(yōu)雅寫法

互聯(lián)網(wǎng)初中高級(jí)大廠面試題(9個(gè)G)
內(nèi)容包含Java基礎(chǔ)、JavaWeb、MySQL性能優(yōu)化、JVM、鎖、百萬并發(fā)、消息隊(duì)列、高性能緩存、反射、Spring全家桶原理、微服務(wù)、Zookeeper......等技術(shù)棧！
?戳閱讀原文領(lǐng)取！                                  朕已閱