【IDEA使用】IDEA配置類註釋模板和方法註釋模板

【背景】

   最近小編在工作中正好接收了新項目，需要給原來的代碼補註釋，爲了能夠更加高效的寫註釋，所以在IDEA裏配置了模板。個人感覺這個模板用着不錯，所以將過程記錄下來分享給大家。（並非權威，如有錯漏，歡迎指正！不勝感激！）

【內容】

1、配置類註釋模板

（1）選擇Setting打開IDEA的設置面板，選擇File and Code Templates-Files-Class進行配置。

（2）將規定的類註釋模板覆蓋原有的類註釋模板

#if (${
   
   PACKAGE_NAME} && ${
   
   PACKAGE_NAME} != "")package ${
   
   PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * @description ${description}
 * @author 自己的名字
 * @since ${DATE} ${TIME}
 */
public class ${
   
   NAME} {
   
   
}

2、配置方法註釋模板

（1）選擇Setting打開IDEA的設置面板，選擇Live Templates，點擊右上角的“+”添加Template Group並命名爲myTemplates。

（2）選中myTemplates後點擊右上角“+”爲myTemplates添加Live Template。

（3）爲該方法註釋模板設置快捷鍵“+Enter”，設置完成後方法前輸入回車後自動添加方法註釋。

（4）將方法註釋模板粘貼至Template text輸入框裏。

**
 * 功能描述
 *
$param$
 * @return $return$
 * @author 自己的名字
 * @since $date$ $time$
 */

（5）點擊Edit variable，在彈出框中爲註釋模板的幾個參數配置相應的表達式

Param的Default value：

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n':'')}; return result", methodParameters())
1

Return的Default value：

methodReturnType()

Date的Default value：

date()

Time的Default value：

time()

（6）將該方法註釋模板配置爲Java代碼環境中使用。

附錄：

參考博客：https://blog.csdn.net/sikefeng/article/details/80557265