“王哥，王哥，程式碼又衝突了！”

“王司，王司，程式碼咋拉下來衝突了！”

血壓瞬間飆升

走近一看，原來是程式碼註釋的不一樣，導致了程式碼衝突，我的血壓就如上圖一樣。

自從到新公司後，這樣的場景已經上演過很多次了。在多次"血淋淋的"事情發生後。終於在上週五，我們下定決心，要統一下程式碼的註釋模板。解決這讓人蛋痛的問題。

首先介紹下：我們使用的開發工具是大名鼎鼎的 "IDEA"。

言歸正傳，開始來介紹設定方法：

類、介面、列舉、註解的註釋模板開啟idea的設定介面快捷鍵Ctrl+Alt+s或者 在導航欄中File->Setting選擇Editor->File And Code Templates；如下圖所示，開啟其中一個看到又一句話#parse("File Header.java"）;此時有兩種設定方式。一種是刪除#parse("File Header.java"),直接在此處新增類、介面、列舉、註解的註釋；另一種是在Includes頁簽下找到File Header 檔案，如果沒有可以自己建立該檔案，然後將我們的註釋模板貼上進去。

示例圖

我的註釋模板      /**  * @author $user$  * @ClassName ${PACKAGE_NAME}.${NAME}  * @Date ${DATE} ${TIME}  * @Version V1.0  * Description  <請輸入一句話描述該類功能>  * Copyright (C) XXX公司  since ${DATE}*/

效果如下所示

效果圖

方法註釋模板開啟idea的設定介面快捷鍵Ctrl+Alt+s或者 在導航欄中File->Setting選擇Editor->Live Templates，選擇新建一個Temlate Group，選擇新建好的template group，新建一個Live Template，有如下四點需要我們編寫的abbreviation——縮略語。指使用該模板的快捷方式，這裡我們設定為*description——描述資訊。該模板的描述資訊Editor variables——編輯模板中的變數資訊，等會兒會重點講解這裡。Expand with——以什麼方式展開模板內容，這裡我們使用預設的。

示例圖

我設定的註釋模板* * <描述方法功能> * <方法詳細功能> * @Author $user$ * @Date $date$ $time$   $param$   * @return $return$ **/

點選Editor variables彈出如下：

將如下的內容複製貼上進 param的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())

設定好的效果圖如下：

最終效果圖

PS：不知道是不是因為版本的問題，方法註釋的abbreviation只能寫 * ,寫成 /** 讀取引數的groovyScript就無法起作用了。有沒有大佬知道的？