IDEA类和方法注释模板设置

一、概述

IDEA自带的注释模板不是太好用，我本人在网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家。本人亲测可用，自己配置过

二、类、接口、枚举类注释模板

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择Class文件、interface、Enum这三个地方

（1）${NAME}：设置类名，与下面的${NAME}一样才能获取到创建的类名

（2）TODO：代办事项的标记，一般生成类或方法都需要添加描述

（3）${USER}、${DATE}、${TIME}：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在绿色框标注的位置，比如你想添加项目名则可以使用${PROJECT_NAME}

2、效果图展示：

这里我创建的是类，若果创建的是接口和枚举类，同样也会有这个注释模版

注释模版

/**
 *@ClassName ${NAME}
 *@Description  TODO
 *@Author houbing
 *@Date ${DATE} ${TIME}
 */

三、方法注释模板
1、创建模板
IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，使用Eclipse时我们生成注释的习惯是

/**+Enter，这里我们也按照这种习惯来设置IDEA的方法注释

1、File-->Settings-->Editor-->Live Templates

新建组：命名为myGroup

然后再点击下面这个按钮就会生成下面这种图

第一个空填 * 第二个空填方法注释

然后在Template text这里面填上

*
 * @Description //TODO $end$
 * @Date $date$ $time$ $param$ $return$
**/

之后点击这个按钮

点击完成后，并进行配置里面的值，配置完成之后，就成下图这样

date配置date()这个值

param这里配置的值如下：

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

return这里配置的值如下：

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

都配置完成之后点击ok，接下来Expand with这个地方，改为Enter这个选项

之后，在按照下图的配置，点击Define之后，选择Java这个选项，到这里就算配置完成

如果之前这里进行配置了，可以点击下面这个按钮进行修改选择项

到这里就已经配置完方法的注释模版，我们一起来验证之后

在方法上面敲 “ /** ” ，然后进行回车，就会生成如下：

文章来源地址https://uudwc.com/A/b1oJP