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

在使用IDEA開發(fā)的過程中，我們可以通過設置代碼注釋模版，實現(xiàn)注釋信息的自動補齊，提高編碼效率。
我使用的是Mac電腦，就以Mac環(huán)境來進行說明吧。

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

一、配置類文件頭注釋模版
點擊IDEA編譯器左上角的“IntelliJ IDEA”按鈕，選擇“Preferences...”，在彈出窗口中，選擇“Editor-->File and Code Templates”，在窗口的右邊“Schema”下拉欄選擇“Default”，然后點擊“Includes”標簽，在右邊模版欄中填寫注釋模版。最后點擊右下角OK按鈕生效。
參考內(nèi)容如下：

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

其中${...}里填寫的是自動填充內(nèi)容的標簽。窗口右下角有IDEA當前支持的標簽列表。

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

添加方法頭的注釋，需要有以下步驟：
（1）首先通過點擊圖中第二步中的“+”號，創(chuàng)建注釋模版分組，比如我們命名為：MethodGroup；
（2）在第四步中的“Abbreviation”輸入框中添加填充注釋時需要輸入的指令關(guān)鍵字，此處我們使用“add”作為關(guān)鍵字，并在第五步中添加指令說明。經(jīng)過這個步驟后，指令關(guān)鍵字會出現(xiàn)在上一步創(chuàng)建的注釋分組MethodGroup中，效果如圖中的第三步；
（3）編輯注釋內(nèi)容模版，參考如下（注意：不需要以 /* 開頭，因為需要我們在添加注釋時會手動輸入）：

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

（4）點擊第七步按鈕，在彈窗中指定注釋代碼里參數(shù)的取值方式。

需要注意的是，如果param參數(shù)默認系統(tǒng)的methodParam()，那么在注釋語句中，將以 “@param: [pa1, pa2...]”形式展現(xiàn)。我們使用groovyScript腳本來設置param的注釋語句格式，讓每個參數(shù)占一行。
腳本內(nèi)容為：

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"來完成。

三、使用代碼注釋模版
上述操作完成后，就可以使用注釋模版了。可以新建一個類，類文件頭注釋會自動生成。

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