在idea中自定义注释模板

intellij idea中设置自定义代码模板

首先,在自定义代码模板中新增快捷方式*,并选择触发按键为Enter

代码注释模板定义如下:

  • $description$:定义方法描述字段
  • $author$:定义方法作者
  • $date$:定义方法定义日期
  • $param$:定义方法参数,该参数需要使用自定义groovy脚本
  • $return$:定义方法返回值,该参数需要使用自定义groovy脚本
1
2
3
4
5
6
7
*
*
* @description $description$
* @author $author$
* @date $date$ $time$
$param$ $return$
*/

变量赋值:

1
description = ""
1
author = user()
1
date = time()
1
2
3
4
return = groovyScript("
def param=\"${_1}\";
if(param == \'\' || param == \'void\') return \'\';
return \' \\n * @return \' + param", methodReturnType())
1
2
3
4
5
6
7
8
9
param =  groovyScript("
def result='';
def params=\"${_1}\".replaceAll(\'[\\\\[|\\\\]|\\\\s]\', \'\').split(\',\').toList();
for(i = 0; i < params.size(); i++) {
if(params[i] == \'\') return \' \';
result+=\' * @param \' + params[i] + \' \' + params[i] + ((i < params.size() - 1) ? \' \\n\' : \' \')
};
return result", methodParameters())

java代码中敲入/**,按下Enter键即可看到自动生成的注释

1
2
3
4
5
6
7
8
9
/**
*
* @description
* @author pengkai
* @date 2022/02/22 下午7:33
* @param username username
* @param password password
* @return org.springframework.security.core.userdetails.UserDetails
*/