创建IDEA类和方法注释模板

创建IDEA类和方法注释模板

类注释模板

打开Settings—Editor—File and Code Templates菜单，在Files标签下点击Class，可以看到右侧有java类的默认模板，如图：

模板包含三部分内容：

1. 第一行的if条件表达式，意思是在java类的第一行引入package信息；
2. 第二行的parse引入一个名为Header的java文件并解析；
3. 第三行开始才是类的主体内容；

设置类注释模板关键就在第二行的Header.java文件上。切换到Includes标签，看到正好有一个名为Header的java文件：右侧上半部分是文件内容，默认是空白无内容的，下半部分是对一些变量的介绍。如下图：

在文件编辑框中编辑类注释模板，填写以下内容：

/**
 * @Description:  //类描述
 * @Author: ${USER}  //作者，也可以直接写字符串，如@Author: admin
 * @Date: ${DATE}  //创建日期
 */

若要添加更多变量，参考Description中的介绍。
标记完成后点击Apply应用模板设置，新建测试类，查看自动创建的类注释：

方法注释模板

打开Settings—Editor—Live Templates，点击“+”添加一个Template Group，名称自定义：


选中新添加的模板组，再次点击“+”，添加一个Live Template:

Abbreviation：生成方法注释的快捷键，这里填写“*”；
Description: 模板备注，可以不填写；
Template text：方法注释模板内容，参照上面图片中的格式：

*
 * @Description:  //方法描述
 $param$  //方法参数，这里需要特殊处理，下面有详细介绍
 * @Return: $return$  //方法返回值类型
 * @Date: $date$ $time$  //方法创建日期和时间
 */

点击图片所示左下角的警告：Define，勾选Java选项

点击右侧的Edit variables，设置变量取值：

1. param ：在Default value列输入以下内容:

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

2. return：点击Expression列从下拉框中选择methodReturnType()
3. date：从下拉框中选择date()
4. time：从下拉框中选择time()
5. 点击OK保存设置
   

点击OK或Apply保存配置。在方法上方外部输入/**，然后按Tab键生成注释：

注意

以上设置方法经验证，适合IDEA 2020.3及以后版本，其他版本的设置方法请参考其他网友的建议。

参考

https://www.cnblogs.com/cxy2020/p/13984298.html