IDEA添加自動註釋（類註釋及方法註釋）

一、添加類自動註釋

• 左上角選擇 File -> Settings -> Editor -> File and Code Templates；
• 然後選擇Includes，點擊“+”號新建文件，內容如下：

/**
*@description：TODO
*@author： ${USER}
*@create： ${DATE} ${TIME}
*/

• 選擇Files -> Class，在類聲明上填入以下內容，並勾選Enable Live Templates 開啓此模板

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

• 或者直接將上面註釋模板替換 #parse(“File Header.java”)

二、添加類方法自動註釋

• 左上角選擇 File -> Settings -> Editor -> Live Templates；
• 點擊“+”號，選擇Template Group；
• 輸入任意名稱；
  
• 創建完成後，自動定位到剛創建的組，點擊右上角，選擇Live Template；
• 自定義任意的Abbreviation，這裏爲了以後操作快捷，直接填寫a，Template Text 內填入以下內容：

 /**
 - @author: $author$
 - @date: $date$ $time$
 - @description: TODO
$params$
 - @return $returns$
 */

• 選擇適用範圍，選擇java，點擊打勾；（需要先進行這步再配置變量，不然配置變量系統方法無法顯示）
• 然後點擊Edit variables ，配置變量。
  
  其中，params爲方法入參數，這裏需要配置groovyScript函數，將下面的內容拷貝到Expression，複製完成後請按回車。

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())

• 使用方法：在方法上部輸入a，按Tab鍵

• 存在的兩個問題：

  • 生成的時候如果不在方法體內，入參如果不是vo等java類，就獲取不到。 解決：建議在方法體內生成，然後移到方法上面；
  • 方法體外生成的位置必須是方法上部一行，如果在@Override上面使用就獲取不到入參和返回值。 解決：先生成註釋，然後再把@Override等方法註解移到下面。