idea 方法注释模板自动生成设置

多个参数：输入描述内容后，多个参数自动对齐
返回：返回类型去掉全类名

1.创建分组
首先创建一个自己的模板分组Template Group，自定义为“MethodNote”；

2.新建模板
选中新建的模板分组，新建一个模板；LiveTemplate
3.模板基本信息
第一步选中新建的模板
第二步为模板定义一个名字
第三步为模板添加描述
第四步填写模板详细信息
切勿在前面加上"/"

**
 * $description$
 * $params$
 * @return $returns$ 
 */

第五步如果没选过的话为Define，选过为change，这边我们点击Define选择java分类,选择快捷键适用范围

4.编辑模板变量
params：

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

returns：

groovyScript("def result='';  def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++)  { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ; };  return result", methodReturnType())

按照图示添加后，右边的 √ 别忘记；点击ok；

右下角Options触发的方式默认为tab，我这边修改为enter了；
先点右下角Apply，再点OK按钮就设置完成了。

5.实际操作
操作方式还是和默认的方法注释操作方法一样；
首先在方法前输入 " /** " 在点击回车按钮即可;
回车后效果图：
最终效果图：添加完描述信息后，所有参数都将自动对齐

idea 方法注释模板自动生成设置

猜你喜欢