IDEA配置類和方法註釋模板

在寫代碼時爲了提升可閱讀性，咱們常常須要給Java等語言的類及方法添加註釋，這時爲了提升效率咱們就能夠用到註釋模板，本文將主要介紹如何用Intelij Idea配置類及方法的註釋模板提升代碼註釋效率。

1.打開Idea，依次選擇【File】--> 【Settings】

 

2.在設置界面的搜索框中輸入live template查找到Live Templates配置項

 

3.點擊最右側的『+』號按鈕，添加一個模板組，這裏組名咱們填寫YC，這樣就完成了一個模板組的建立，接下來咱們將在這個模板組下建立類註釋及方法註釋模板。

2、配置類註釋模板

(1)選中模板組YC，在最右側單擊『+』號按鈕，添加【Live Template】，輸入模板基礎信息（模板名稱填寫ccmt，模板介紹填寫類註釋模板），填寫完成後單擊第二張圖片箭頭指向處設置要針對的語言（這裏咱們只選擇了Java和JavaScript）

(2)在以下方框內輸入模板內容：

/**
* @Description:    java類做用描述
* @Author:         yc
* @CreateDate:     $DATE$ $TIME$
* @UpdateUser:     yc
* @UpdateDate:     $DATE$ $TIME$
* @UpdateRemark:   修改內容
* @Version:        1.0
*/

注意：能夠根據須要設置更多變量，在接下來的步驟中給設置的變量配置相應的取值函數。

(3)單擊【Edit Variables】編輯變量，分別給上面的兩個變量Date、Time設置取值函數date(),time()，設置完成後單擊【OK】保存。

(4)打開Java文件，在Java類上面輸入ccmt後按下回車鍵便可快速添加類註釋模板

3、添加方法註釋模板

(1)參照【2、配置類註釋模板】，添加方法註釋模板，模板名稱爲mcmt，模板內容爲：

/**
* 方法實現說明
* @author      做者姓名
$param$
* @return      $return$
* @exception   $exception$
* @date        $date$ $time$
*/

 

也能夠設置爲:

/**
 *  @Description 
 *  @Param $params$
 *  @Return $return$
 *  @Author xiayuxuanmin
 *  @Date $date$
 */

變量設置爲:

(2)點擊上圖的【Edit Variables】編輯變量，其中param中填寫Groovy腳本：

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\\b' : '')}; return result", methodParameters())

其餘變量則從下拉框中直接選擇下圖對應的便可。

(3)完成上面的模板配置後，在以下方法上面輸入mcmt，而後按下Tab鍵或回車鍵就能夠看到生成的方法註釋嘍！

https://jingyan.baidu.com/article/19192ad8eb4134e53e5707a6.html