IDEA 创建类注释模板和方法注释模板详解

Idea注释可以简单的分为两类：类注释模板和自定义方法注释模板；

类注释模板相对简单，网上有很多教程，自己想要什么样的格式都可以实现，本文作简单描述。自定义方法注释模板，重在参数的配置，本文着重讲述。

先说一下mac和win环境下Idea配置进入：（具体操作看图）

 

 

1. 类注释模板

      类注释模板更改如下图四个，开发java这四个应该就足够了吧。个人采用的是同一个模板！

      具体模板如下：

/**  
 * @Description: ${END}
 * @ClassName: ${NAME}
 * @Date ${DATE} ${TIME}
 * @Author ${USER}
 */

      效果如图：

2. 自定义方法注释模板

      自定义方法模板还是先创建一个属于自己的自定义组吧，如图点击+号出现两个选项可供操作，1为创建模板，2为创建组。个人创建的组为MySetGroup！

    成功创建组以后，创建一个空模板，如下图所示：

模板信息按照个人需求完善，重点来了！重点来了！重点来了！

先针对上图做一番介绍：

1. 模版调用关键字  2.模版介绍  3.模板 4.使用环境  5.模板调用快捷键  6.模版内容配置（这是重点）

1,2不再说明，(3)直接贴模板：

*
 * @Description: 方法$methodName$的功能描述：TODD
 * $VAR1$ $params$
 * @Return $return$
 * @throws 
 * @Author $user$
 * @Date $date$ $time$ 
 */

(4) 使用环境, 点击change，找到java，选上即可

 

(5) 模板调用快捷键, 有多种选择，默认tab，看个人习惯选择。

(6) 模版内容配置, 如下图

VAR1: 参数

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

效果：

个人总结，希望能帮助到你！