IDEA 自定義方法注解模板的實現方法

1、使用效果

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

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

File->settings->Editor->Live Templates

擊右上角的綠色+號，然后選擇template group ，然后輸入group的name，隨便輸入就好了：wangjiafang。然后點ok

選中剛才創建的wangjiafang，然后再次點擊右側的綠色+，這次選擇的是第一個 Live Template

取名為*

Live Template 定義的模板名是 * , 按/**, 然后space鍵盤, 方法注釋就生產了,非常完美!; 網上普遍的方式是將模板名定義為: mc, 使用方式也相應不同, 其實使用方式倒無所謂, 但是mc這種方式有個要求, 必須再方法內使用才行,要不產生的注釋param 是null..., 所以你用這種方式,要么你忍受方法內寫注釋,要么你手動把方法內生成的注釋移到外面

把Expand with中 默認enter 修改為space,當然你也可以修改為其他的快捷方式；為什么要什么默認的enter，因為 /** 是idea的默認注釋快捷，和要使用默認注釋模板的地方沖突

注釋模板代碼

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

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

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())

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。