配置IDEA上的代码注释:
1、注释中作者信息非常重要,可以通过虚拟机环境变量进行配置。
点击 Help->Edit Custom VM Options...打开idea.vmoptions文件,在最下面增加一行-Duser.name=用户名。
2、配置类、接口、枚举注释模板。
打开IDEA代码模板配置界面,分别配置Class、Interface、Enum.
注释模板内容如下:
/**
* @description TODO
* @author ${USER}
* @date ${DATE} ${TIME}
* @version 1.0
*/
3、配置方法模板
打开Live Templates界面
填写模板的内容:
Abbreviation:输入*星号,在方法上输入反斜杠加星号自动生成注释。
Description:模板的描述
Template text: 模板内容
如下:
**
* @description TODO
* $params$
* @return $return$
* @author $user$
* @date $data$ $time$
*/
点击Edit Variables编辑模板中用的变量
对于params方法的参数需要填写脚本,如下:
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()
);
最后点击确定即可