文章目录
- 概要
- 配置类注释模板
- 配置方法模版
概要
配置类注释和方法注释
配置类注释模板
点击setting->Editor->File and Code Templates,然后找到Class,如下图:

注意勾掉Reformat according to style,否则会格式化。
注释模板如下:
/**
* @packageName ${PACKAGE_NAME}
* @className ${NAME}
* @description TODO
* @version 1.0
* @author 作者名
* @date ${DATE} ${TIME}
*/
类模版配置完毕之后,新建类会自动加上注释。
其他如接口类Interface、枚举类Enum按照如上方法处理就行了。
配置方法模版
1、点击setting->Editor->Live Templates,点击右边带三角的➕图标,如下图:

2、选择 2 Template Group...,填写名字methodTemp。
选中刚才填写的名字methodTemp,在点击右边框的三角➕,选择1 Live Templates ,如下图:

3、接着 Abbreviation填*,Template text填注释模板,如下图:

方法注释模板,如下:
*
*
* @Desc $desc$
$params$
* @return $returns$
* @date $date$ $time$
*
*/
4、接着 点击Edit Variables...,填写参数:

这个填到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())
这个填到 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())
5、填写完参数之后,点击define,如下图:

6、然后把 Java 选项全都勾选上,

7、最后把Expand with改成 enter,即回车后补全注释。

最后,Apply,Ok 就行了。


















