Idea添加自定义模板

Java代码规范中对注释有各种要求，添加注释对于代码的可读性，可持续性，质量都至关重要，下面看怎么通过模板在idea中添加自定义的注释模板，并且能够被JavaDoc识别并生成在API文档中。

类，接口，注解，枚举

在idea中打开
File—>Settings—>Editors—>File and Code Templates
在Files中找到Class可以看到右边的模板，只需要将以下注释添加到响应的位置即可
添加内容

/**
 * 
 * @author ${USER}
 * @date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}
 **/

添加后

然后新建Java文件就可以看到自动添加了注释了

package com.zdxf.server.service.impl;

/**
 * @author weihao
 * @date 2021/01/22 14:27
 **/
public class TestAAA {
}

方法

在idea中打开
File—>Settings—>Editors—>Live Templates
然后新建Template Group，命名为自己喜欢且不重复的名称，如我命名为MyGroup，如图

添加完成Template Group后，选中添加的Template Group，继续添加Live Template，如图：

添加完成后开始配置Live Tempalte

其中，
第三步，模板内容如下

**
 * $param$
 * @throws $throws$
 * @return $return$
 * @author $user$
 * @date $date$ $time$
 */

第五步，模板变量配置如下表

具体如下：

param: groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {result+= '\\n     * @param ' + params[i] + ' ' }; return result;}", methodParameters());
throws: completeSmart()
return: methodReturnType()
user: user()
date: date()
time: time()

第六步，注释位置配置如下图

配置完成后Apply—>Ok
测试
在任意方法上键入/$$ 并tab键入之后，可以看到生成的注释如下：

    /**
     * 
     * @param a 
     * @param b 
     * @throws Exception 
     * @return java.lang.Object
     * @author weiha
     * @date 2021/1/22 15:57
     */
    Object test(String a, String b) throws Exception {

        return "1";
    }

（^_^）