IDEA 自定義方法註解模板

IDEA 自定義方法註解模板

一、使用效果

/**
* 計算交易費用
* @Author wangjiafang
* @Date  2019/9/11
* @param feeComputeVo
* @return
*/
@PostMapping("/v1/fee_compute")
public ApiResponse feeCompute(@RequestBody @Valid FeeComputeVo feeComputeVo){
return new ApiResponse();
}

二、設置步驟-添加自定義方法

1. File->settings->Editor->Live Templates

2. 擊右上角的綠色+號，而後選擇template group ，而後輸入group的name，隨便輸入就行了：wangjiafang。而後點ok

3. 選中剛纔建立的wangjiafang，而後再次點擊右側的綠色+，此次選擇的是第一個 Live Template

4. 取名爲*

Live Template 定義的模板名是 * , 按/**, 而後space鍵盤, 方法註釋就生產了,很是完美!; 網上廣泛的方式是將模板名定義爲: mc, 使用方式也相應不一樣, 其實使用方式倒無所謂, 可是mc這種方式有個要求, 必須再方法內使用才行,要不產生的註釋param 是null..., 因此你用這種方式,要麼你忍受方法內寫註釋,要麼你手動把方法內生成的註釋移到外面

5. 把Expand with中 默認enter 修改成space,固然你也能夠修改成其餘的快捷方式；爲何要什麼默認的enter，由於 /** 是idea的默認註釋快捷，和要使用默認註釋模板的地方衝突

6. 註釋模板代碼

*
* $desc$
* @Author wangjiafang
* @Date  $date$
$params$
* @return
*/

三、設置步驟-添加方法中的變量

IDEA 中methodParameters(), 是數組的形式([aParam, bParam, cParam]這樣的結構),須要對methodParameters() 函數進行處理，處理腳本以下：

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