在Mac版本下的IDEA中設置代碼註釋模版

在使用IDEA開發的過程當中，咱們能夠經過設置代碼註釋模版，實現註釋信息的自動補齊，提升編碼效率。
我使用的是Mac電腦，就以Mac環境來進行說明吧。

在Mac上配置IDEA的代碼註釋模版，主要包括兩個部分：一個是File Head文件頭註釋，用於描述類文件的信息；一個是方法頭註釋，用於描述類方法的信息。具體配置過程以下。

1、配置類文件頭註釋模版
點擊IDEA編譯器左上角的「IntelliJ IDEA」按鈕，選擇「Preferences...」，在彈出窗口中，選擇「Editor-->File and Code Templates」，在窗口的右邊「Schema」下拉欄選擇「Default」，而後點擊「Includes」標籤，在右邊模版欄中填寫註釋模版。最後點擊右下角OK按鈕生效。
參考內容以下：

/**
 * 項目名稱：${PROJECT_NAME}
 * 類 名 稱：${NAME}
 * 類 描 述：TODO
 * 建立時間：${DATE} ${TIME}
 * 創 建 人：${USER}
 */

其中${...}裏填寫的是自動填充內容的標籤。窗口右下角有IDEA當前支持的標籤列表。

2、配置方法頭註釋模版
點擊IDEA編譯器左上角的「IntelliJ IDEA」按鈕，選擇「Preferences...」，在彈出窗口中，選擇「Editor-->Live Templates」，進入方法頭註釋模版編輯界面，以下圖。

添加方法頭的註釋，須要有如下步驟：
（1）首先經過點擊圖中第二步中的「+」號，建立註釋模版分組，好比咱們命名爲：MethodGroup；
（2）在第四步中的「Abbreviation」輸入框中添加填充註釋時須要輸入的指令關鍵字，此處咱們使用「add」做爲關鍵字，並在第五步中添加指令說明。通過這個步驟後，指令關鍵字會出如今上一步建立的註釋分組MethodGroup中，效果如圖中的第三步；
（3）編輯註釋內容模版，參考以下（注意：不須要以 /* 開頭，由於須要咱們在添加註釋時會手動輸入）：

* 
 * @name: $enclosing_method$ 
 * @description: TODO  $param$
 * @return: $return$
 * @date: $date$ $time$
 * @auther: $user$
 * 
*/

（4）點擊第七步按鈕，在彈窗中指定註釋代碼裏參數的取值方式。

須要注意的是，若是param參數默認系統的methodParam()，那麼在註釋語句中，將以 「@param: [pa1, pa2...]」形式展示。咱們使用groovyScript腳原本設置param的註釋語句格式，讓每一個參數佔一行。
腳本內容爲：

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

（5）接下來指定填充註釋語句的提示字符，經過窗口中的「Expand with」來指定。"Space"表示空格，"Tab"表示 Tab鍵。
（6）最後是指定註釋的使用範圍，經過點擊窗口下面的「...Change"來完成。

3、使用代碼註釋模版
上述操做完成後，就可使用註釋模版了。能夠新建一個類，類文件頭註釋會自動生成。

在類中新建一個方法，而後在方法上面輸入 /*add ，並按 Space鍵(空格鍵) ，就會自動補齊整段註釋代碼了。