原因
idea生成注释时,需要在指定的代码块下才会生效,大部分无法获取Param及return的值都是因为缺少外层代码块
解决
既然需要指定代码块包裹,那就将生成注释步骤拆分为两步
生成指定格式代码块
在代码块内再生成注释
使用时先执行1,再执行2
可行方案
创建两个自定义模板,内容如下
/*$END$
*/
*
* @Author $user$
* @Date $date$
* @Param $param$
* @return $return$
代码块脚本内容
paramsDefault value内容
groovyScript("if(\\"${_1}\\".length() == 2) {return '';} else {def result=''; def params=\\"${_1}\\".replaceAll('[\\\\\\\\[|\\\\\\\\]|\\\\\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\\\\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());
return变量 Default value内容
groovyScript("def returnType = \\"${_1}\\"; def result = '* @return: ' + returnType; return result;", methodReturnType());
使用
先 // 回车
生成方法注释
在注释内使用定义的快捷短语
输入 /// + 回车 后,自动生成注释