IDEA 注釋模板這樣搞！爽！
1、為什么國內(nèi) 996 干不過國外的 955 呢？ 2、在部隊當程序員是什么體驗？ 3、神級程序員都在用什么工具？ 4、是時候扔掉 Postman 了，Apifox 真香！ 5、這幾個 GitHub 項目真帶勁
來源：https://jitwxs.cn/4135e0a9.html
Settings，點擊 Editor-->File and Code Templates，點擊右邊 File 選項卡下面的 Class，在其中添加圖中紅框內(nèi)的內(nèi)容：/**
?* @author jitwxs
?* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
?*/
Description 中被列出來。Interface 項即可。根據(jù)形參數(shù)目自動生成 @param注解根據(jù)方法是否有返回值智能生成 @Return注解
Settings 中點擊 Editor-->Live Templates。+，首先選擇 2. Template Group... 來創(chuàng)建一個模板分組：
userDefine，然后點擊 +，選擇 1. Live Template：
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 還不認識這些參數(shù)是啥玩意，下面我們對這些參數(shù)進行方法映射，讓 IDEA 能夠明白這些參數(shù)的含義。點擊 Edit variables 按鈕：
Expression：
date 和 time 的 Expression 使用的是 IDEA 內(nèi)置的函數(shù)，直接使用下拉框選擇就可以了，而 param 這個參數(shù) IDEA 默認的實現(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屬性，它的意思是如果在生成注釋時候如果這一項被定義了，那么鼠標光標就會直接跳過它。我并不需要這個功能，因此有被勾選該屬性。
3.2 方法注釋
無形參 單個形參 多個形參 無返回值 有返回值
四、Q & A
Abbreviation 一定要叫 \* ？Expand with 要保證是 Enter 鍵？模板名 + 生成鍵，當生成鍵是 Enter 時，我們輸入 * + Enter 就能夠觸發(fā)模板。* 了，因為當我們先輸入 /*，然后輸入 * + Enter，觸發(fā)模板，首行正好拼成了 /**，符合 Javadoc 的規(guī)范。\*？$time$$param$ 這兩個明明不相干的東西為什么緊貼在一起？@param，因此我對param 函數(shù)的代碼進行修改，使得在無參情況下不生成 @param，但是這就要求 $param$ 要和別人處在同一行中，不然沒法處理退格。methodReturnType()， 而要自己實現(xiàn)？methodReturnType() 在無返回值的情況下會返回 void，這并沒有什么意義，因此我對 methodReturnType() 返回值進行了處理，僅在有返回值時才生成。$return$ 不是單獨一行？methodReturnType() 返回 null 時，無法處理退格問題，原因同第三點。
往期熱門文章：
1、《歷史文章分類導(dǎo)讀列表！精選優(yōu)秀博文都在這里了！》 2、Spring Boot + GraphQL 才是 API 的未來！ 3、全員遠程辦公，半年入 1 億美元：GitHub 的最大競爭對手上市了！ 4、聊一聊Java 泛型通配符 T，E，K，V，? 5、各大公司程序員的工位，你中意哪一款？ 6、Stackoverflow 高贊答案，為什么牛逼的程序員都不用 “ ! = null ' 做判空？ 7、為什么不建議在MySQL中使用 utf8 ？ 8、編寫Spring MVC控制器的14個技巧！漲知識了！ 9、日志打印的15個建議！血淚??！ 10、List中remove()方法的陷阱，被坑慘了！
評論
圖片
表情