IntelliJ IDEA配置类注释模板和方法注释模板

发表于 分类于 ， 阅读次数： 本文字数： 1.4k 阅读时长 ≈ 1 分钟

IntelliJ IDEA配置类注释模板和方法注释模板

类注释模板

在File->Settings->Editor->File and Code Templates->Includes目录下添加如下代码

1
2
3
4
5
/**
 * @Description TODO
 * @author liquanhong
 * @createTime ${YEAR}/${MONTH}/${DAY}
 */

方法注释模板

在File->Settings->Editor->Live Templates。
编辑变量的时候Reformat according to style和Shorten FQ names两个复选框打钩

参数分开显示

在这里插入图片描述
Template text的代码如下：

1
2
3
4
5
6
7
*
 * TODO
 * $params$
 * @return $return$
 * @author liquanhong
 * @date $date$
 */

params变量代码如下：

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

return变量代码：

1
methodReturnType()

date变量代码：

1
date()

效果：

1
2
3
4
5
6
7
8
9
10
/**
 * TODO
 * 
 * @param: a
 * @param: b
 * @param: c
 * @return java.lang.String
 * @author liquanhong
 * @date 2021/7/19/019
 */

参数以数组方式显示

Template text代码如下：

1
2
3
4
5
6
7
*
 * TODO
 * @params $params$
 * @return $return$
 * @author liquanhong
 * @date $date$
 */

params变量代码：

1
methodParameters()

return变量代码：

1
methodReturnType()

date变量代码：

1
date()

效果：

1
2
3
4
5
6
7
/**
 * TODO
 * @params [a, b, c]
 * @return java.lang.String
 * @author liquanhong
 * @date 2021/7/19/019
 */

问题解决

可以看出上面的注释日期格式（2021/7/19/019）有问题，解决方法是把date变量代码改为：

1
groovyScript("def result =\"${_1}\".substring(0,9); return result",date())

参考链接