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