IDEA 自定义 方法注释模板

IDEA自带的注释

IDEA自己生成的注释比较单调,不够炫,所以我们要自定义方法注释的模板;

创建模板

因为IDEA生成注释的默认方式是：/*+模板名+快捷键（比如若设置模板名为add快捷键用Tab，
则生成方式为/*add+Tab），
如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参methodParameters(）

所以我们首先创建一个能生成 杠星的模板
模板命名为ct

然后我们继续创建一个带有注释文本的模板
模板命名为*

模板内容

在设置参数名时必须用${参数名}$的方式，否则第五步中读取不到你设置的参数名

这个模板才是与IDEA最契合的方法注释,也和源码的注释风格类似,直接复制即可

**
 * $end$
 *       
 * @author Hope
 $params$
 * @return $return$
 */

设置模板应用场景

一般选择EveryWhere–>Java即可

设置参数

选择右侧的Edit variables按钮

IDEA格式的模板只需要为每个参数选择对应的方法即可

params 方法里面的内容:

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

效果

按键: ct -> tab -> tab