03 IntelliJ IDEA（版本2019.1.3）设置类注释模版和方法模版详解

背景

Java中的注释规范是编码规范的一部分，然而如果要求每个程序员都按约定编写注释对程序员来说也是一件苦差事，好在各种IDE都可以设置注释模版，可以要求团队的所有程序员在IDE中设置统一的注释模版来统一注释的规范。今天就详细说一下在IntelliJ IDEA中如何设置类注释模版和方法注释模版。
1、 设置类注释模版
1.1 首先打开菜单File->Settings打开设置对话框，在Editor->File and Code Templates的右侧选项卡Files中找到Class，如下图所示：

可以看到在类的代码模版中public class上有一句#parse(“File Header.java”)，因此我们只要在File Header.java中设置自己的模版就可以了。
1.2 在Editor->File and Code Templates的右侧选项卡includes中找到File Header，如下图所示：

我们在Includes下找到File Header文件，编辑模版内容如下：

/**
 * @description: 
 * @author: ${USER}
 * @date: Created in ${DATE} ${TIME}
 * @version: ${VERSION}
 * @modified By:
 */

点击Apply应用模版，点击OK关闭设置对话框，然后新建一个类，可以看到对应的类注释自动生成，你可以在@description后编写对类的功能说明。如下图：

这样在IDEA中类注释模版就设置完毕了。
2、 设置方法注释模版
在IDEA中设置方法注释模版并不像Eclipse中那样方便，下面我们就说一下详细步骤。
2.1 选择菜单File->Settings打开设置对话框，找到Editor->Live Templates如下图：

2.2点击右侧的+号会出现一个菜单，选择菜单2.Template Group创建一个模板组，如下图所示：

在创建模板组对话框中输入组名：Java，点击OK，如下图：

2.3 选中新创建的模板组Java，然后点击右侧的+号，出现菜单如下图：

选择菜单1.Live Template，出现下图：

可以看到上图标注了5个区域：
**区域1：**因为我们希望在方法前输入

/**+Enter

实现根据模版生成注释，因此在By default expand with后的组合框中选择Enter。
**区域2：**Abbreviation是缩写，这里输入

/**

Description是描述，这里输入Method Comment Template。
**区域3：**是模版内容，这里输入：

/** 
 * @description 
 * @author $author$
 * @date $date$ $time$
$params$
 * @return $return$
 */

其中$$中的内容代表变量
**区域4：**Edit variables是对模板内容中用到的变量进行编辑，点击Edit variables按钮出现编辑模版变量对话框，如下图：

其中params需要写脚本，内容如下：

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

**区域5：**选择应用上下文，如下图：

勾选Java，点击Apply应用设置，点击OK关闭对话框。
2.4 在类中创建一个方法，在方法体内（在方法前生成的@param部分为空）输入/**回车，就会自动按方法注释模版生成注释，如下图所示：

然后把注释前贴至方法前（目前IDEA在方法注释模版的使用不如Eclipse好），如下图：

至此，在IDEA中设置类注释模版和方法注释模版的过程介绍完毕，希望能够帮到小伙伴们~