在使用Idea的時候，它的註釋模板很簡單，不夠詳細；所有大多數開發者都想設定一個比較詳細的註釋模板，我現在把我瞭解的建立類註釋模板和方法註釋模板的操作記錄下來，分享給大家
我們需要定義的註釋模板如下：
類註釋模板：

方法註釋模板：

一、設定IDEA 中的類註釋模板
File -> Settings -> Editor -> File and Code Templates -> Files
選擇Class , Interface ，Enum 等等，我們都可以看到，在右側區域中，在public class 上面，都有一行 #parse(“File Header.java”) ，

這句程式碼是引入了File Header.java檔案，作為我們建立的Class Interface ,Enum 等檔案的註釋，那麼這個類在哪呢，我們可以看到，在 Files 右側，有一個 Includes 選項，在這裡，我們可以定義各種的模板，在需要的地方去引入這個模板，這裡已經在類檔案中引入了File Header.java 模板，那我們就更改這個模板成為我們想設定成的樣子

/**
 * @ClassName ${NAME}.java
 * @author admin
 * @version 1.0.0
 * @Description TODO
 * @createTime ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}:00
 */
 

*注：
  $PACKAG{E}_N$

A M E : 包 路 徑   {PACKAGE_NAME} : 包路徑   {NAME} : 檔名
${USER} ： 主機使用者名稱
${DATE} ： 系統當前日期，格式為：yyyy/mm/dd
${TIME} ： 系統當前時間 格式為：HH:mm
${YEAR}：當前年
${MONTH}：當前月
${MONTH_NAME_SHORT} ： 月份名稱簡寫；如：Jan, Feb, etc.
${MONTH_NAME_FULL} ： 月份名稱全拼；如：January, February.
${DAY} ：當前天
${DAY_NAME_SHORT} ：星期簡寫；如：Mon, Tue, etc.
${DAY_NAME_FULL}：星期全寫；如：Mon, Tue, etc.
${HOUR} ： 當前小時
${MINUTE} ：當前分鐘
${PROJECT_NAME} ： 專案名稱
 
二、定義方法註釋模板
File -> Settings -> Editor -> Live Templates

1. 在Live Templates 右側點選+號，新增一個Templates Group，命名為 methodTemplates
   

2. 在剛剛建立的 methodTemplates 下建立一個 Live Templates ，如下

• 1）、在位置1處： 輸入模板的簡寫碼
  在位置2處：輸入模板的描述
  在位置3處： 輸入方法註釋模板樣式，可變變數要用 $變數名$ 來表示，如： $param$；
  若不設定成如此的變數名，位置4不可點選，模板如下：

/**
 * @title $title$
 * @description $description$
 * @author admin $param$
 * @updateTime $date$ $TIME$ $return$
 * @throws $throws$
 */

        點選位置4處：可編輯定義的變數的值，如下：

變數param 為方法的引數變數，需要根據方法的引數多少進行變化；變數 return 為返回值型別，也要根據方法的返回值進行變化，所一要自行設定該方法，設定的程式碼如下，複製貼上即可：

param :

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

return :

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())

• 2）、在位置3下方，點選選擇該模板應用的範圍，可選Everywhere 表示任何位置都可新增該註釋
  

改位置首次為 define

修改時為change

• 3）、點選options 中的 Expand with 可選擇該模板配合使用的快捷鍵，如 Tab鍵，Space 空格鍵 ， Enter 回車鍵 等等；
  

如在這裡設定的模板關鍵詞為 * ，配合使用快捷鍵為Tab鍵
則在方法中輸入 * ，在按下Tab 鍵，即可按照模板生成註釋。

---

大功告成，僅供參考！