IDEA中添加自定义的类和方法的注释模板

之前就听说IDEA和Eclipse一样可以自定义注释的模板，方便读者理解。今天try了一下，在此做一个记录。

1. 类的自定义注释模板

打开File-settings-Editor-File and Code Templates，找到class,在右边编辑想要的注释模板即可。设置完成之后，新建一个类的时候会跳出一个输入description的框，输入之后就会创建一个自带注释的类。
在这里插入图片描述
附上常见的一个注释模板：

/**
* @ClassName ${NAME}
* @Description TODO
* @Author Martina
* @Date 2019/2
* @Version 01
**/

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: Martina
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

其中，IDEA中内置的方法有：
（1） ${NAME}：设置类名，与下面的$ {NAME}一样才能获取到创建的类名

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

（3） ${USER}、$ {DATE}、${TIME}：设置创建类的用户、创建的日期和时间

其他可以使用的内置方法见下图中的Description。
在这里插入图片描述

查找资料之后，发现在includes–File Header中也可以实现类的注释模板的定义。但是不如上述方法通用，建议使用上述方法。
在这里插入图片描述

2.方法的自定义注释模板

File-settings-Editor-Live Template，点击+号，添加一个新的Template group,命名为自定义，我写的是trl。
在这里插入图片描述
选择当前建立的Group，点击+，新建一个Live Template.

给新建的模板设置属性，见下图。
1. 模板名称，改为*；
2.模板描述，随意写（我写的是method description）；
3. 模板内容,如下：

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

4.Expand with 选择Enter，这个是快捷键，也就是当我们在自定义方法注释的时候，键盘输入/**点击Enter即可出现注释。
5.Edit Variables，选择每个参数对应的获取方法（有教程说在下拉选择框中选择即可，但是我没找到下拉框，就直接手动输入了）
在这里插入图片描述
6.点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可（这个步骤在上图中未标出，请读者自行操作即可）

7.设置完毕，点击apply，退出settings即可实验。

改进

按照上述步骤完成之后，我们可以发现，params（如果有多个方法的参数）是按照数组的形式呈现的。如下图：
在这里插入图片描述
那么如果读者希望改为一行一行显示，如下图：

可以进行如下修改：

在编辑内容中将 * @Param $param$ 改为 $param$ .
在Edit Variables中将Default 改为如下代码
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())