分享一个自己使用的方法注释。
1.创建模板
- 首先创建一个Template Group
- 选中自己的创建Template Group,点击Live Template,创建模板。
- 填写具体模板
点击Define按钮,选择模板的生效范围,例如java
接着输入如下信息
- Abbreviation 中填写快捷方式,这里填写 **。
- Expand with 这里选择 Default(Tab), 这个表示点击快捷键生成模板。至于不选择Space 方式,是为了不覆盖默认的注释生成。
**
*
* @author demo
* @date $date$ $time$ $param$
* @return $return$
*/
接着点击Edit variable按钮,具体选项如下:
param信息:
groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(params[i]=='null'){return;}else{result+='\\n' + ' * @param ' + params[i] + ' '}}; return result;}", methodParameters());
return信息:
groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())
将param和return内容复制到输入框,点击OK 即可。
2. 实现效果
实现效果如下: