Contents

IDEA set auto-annotation

自定义文件header

/images/2022-08-14-IDEA设置自动注释/1

首先打开设置,选择文件和代码模板,在包含(Includes) 中选择File Header,如下图:

/images/2022-08-14-IDEA设置自动注释/2

在其中粘贴如下内容:

1
2
3
4
5
6
7
8
/**
* <p>
* $description
* </p>
* 
* @author ${USER}
* @since ${DATE}
*/

可以实现创建文件时自动生成作者和日期信息,同时以后在创建文件时会要求输入文件描述显示在 $description 处。

/images/2022-08-14-IDEA设置自动注释/3

新建一个Java Class文件,结果如下:

/images/2022-08-14-IDEA设置自动注释/4

自动生成方法参数注释

打开设置,找到实时模板(Live Templates)

/images/2022-08-14-IDEA设置自动注释/5

选择 + 在出现的选单中选择模板组,模板组名字任意,在此我使用的是自己的用户名,

创建完成后选择对应的模板组,再次选择 + 创建动态模板,模板名字自定义,这里用*,然后在模板文本中粘贴如下内容:

1
2
3
4
5
6
7
**
 * @Description:
 * @Author: $USER$
 * @Date: $date$ $time$
 $param$
 $return$
 **/

/images/2022-08-14-IDEA设置自动注释/6

选定模板的应用范围,这里是Java代码,就选Java

/images/2022-08-14-IDEA设置自动注释/7

然后选择旁边的编辑变量

/images/2022-08-14-IDEA设置自动注释/8

param默认值里的内容如下:

1
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());

return默认值里的内容如下:

1
groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());

date的表达式为date()

USER的表达式为user()

time的表达式为time()

最后测试一下,在写的方法上一行输入"/*",然后按Tab键,成功生成。

/images/2022-08-14-IDEA设置自动注释/9