在idea中為類和方法自動生成注釋

• 一、設置類級別的注釋(創建類是自動生成注釋)
• 二、設置方法級別的注釋

一、設置類級別的注釋(創建類是自動生成注釋)

圖中的代碼塊:

/**
* @author ${USER}
* @date ${DATE} ${TIME}
*/

/**
* @author sjl
* @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/

上述8個變量說明:

$ {USER}：當前系統登錄的用戶名，如果你的系統用戶名是windows默認的Adminstrator，千萬別用，鬼知道你 的同事里有多少人也是Administrator

${DATE}：當前系統設置的日期格式，作為一個有強迫症的程序員，不能接受同一項目的注釋里有超過一種的日期格式

${TIME}：當前系統設置的時間格式，作為一個有強迫症的程序員，不能接受同一項目的注釋里有超過一種的時間格式

${YEAR}：完整的年份，比如 2018

${MONTH}：完整的月份，比如 01

${DAY}：完整的日期，比如 17

${HOUR}：24小時制的小時，比如 16

${MINUTE}：完整的分鍾，比如 52

二、設置方法級別的注釋

1. 如圖，創建一個新的group。
   
2. 然后在添加模板。
   
3. 編輯模板。
   
   步驟說明:

• 1是設置的快捷鍵，我這里設置的三個星號。

• 2是模板代碼塊

  **
  * @description $description$
  $params$  //也可以將此行改為   * @params $params$
  * @return  $return$
  * @author  SJl
  * @date  $date$ $time$
  *
  */
  

  注意這里的代碼塊前面是沒有/的，在方法外敲/+***+Enter就能生成注釋，如果你寫成/**開頭的話在方法外敲是不能獲取return和params參數的，只有在方法內敲才能獲取到。

• 3是選擇生效區域，點擊define，選擇everyWhere 或者 java。

• 4是參數設置。
  
  2的模板代碼塊如果你寫的是* @params $params$，參數設置請選擇 methodParameters()，如果你寫的是$params$，請粘貼以下代碼

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

• 5是選擇按鍵，默認的是Tab，我一般選Enter。

6. 兩種不同的顯示效果。
   

參考鏈接