idea自动类和方法注释模板

类和方法注释模板

1.修改类注释模板 
在File->Settings->Editor->File and Code Templates下分别修改Class，Interface，Enum等注释模板，Class模板部分修改如下，其余的举一反三进行修改。

图1：

以下所示的${DESCRIPTION}是自定义变量，会在创建类时请求输入。图中圈住的里面可以找到可以使用的变量。

/**

* Copyright (C), 2015-${YEAR}, XXX有限公司

* FileName: ${NAME}

* Author: ${USER}

* Date: ${DATE} ${TIME}

* Description: ${DESCRIPTION}

* History:

* <author> <time> <version> <desc>

* 作者姓名 修改时间 版本号 描述

*/

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")

package ${PACKAGE_NAME};

#end

 

/**

* 〈一句话功能简述〉<br>

* 〈${DESCRIPTION}〉

*

* @author ${USER}

* @create ${DATE}

* @since 1.0.0

*/

public class ${NAME} {

 

}

类注释模板修改配置图 

图2：

类注释模板修改效果图 

图3：

2.方法注释模板修改 
在File->Settings->Editor->Live Templates下添加自定义Template Group，并在自定义Template Group下添加自定义Template，具体配置如下图所示 

图4：此图中的所有设置信息都是可直接用的，可以完全按照图中填写。

详细配置参数

3处Template text内容如下:

 *  
 * 
$params$
 * @return $returns$
 * @author clouds234@163.com
 * @date $date$
 */

4处的名称填写*

然后点击上图中红色手写7的按钮弹出下面图；

图5：

Edit Template Variables请求参数部分内容如下:

params:后面的Expression中填写下面这段代码：

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

returns：后面填写如图中的方法；

date：填写如图；

在完成如上配置后，点击图4中5所在的位置的蓝色change（如果未定义过会是define）。然后勾选所有文件。

再讲图4中6所示位置改为如图的enter。

图4中的信息都是可用的，可完全按照图中填写。保存即可。

只需在方法上面一行执行/**+Enter键即可生成注释

方法注释模板修改效果图 

图6：

 

参考文章：

https://blog.csdn.net/yuruixin_china/article/details/80933835

https://zhuanlan.zhihu.com/p/32891910