IDEA自动生成类注释和方法注释应用及模板设置

为了统一自己和小伙伴们的注解风格，所以需要修改Idea的类注解和方法注解模板，在之前的项目中曾经用过eclipse工具配置过，但是现在改用idea了就趁这个机会将Idea中注解模板配置步骤写成一篇文章，供日后查阅。

一、类注解模板配置

步骤一：打开Idea，在菜单栏中找到 File ->setting -> File and Code Templates 后点击，选择右侧的Class，出现以下界面：

步骤二：将类注解模板写到public class ${NAME}上方，这里我的自定义类注解模板，如下：

/**
* @Program: ${PROJECT_NAME}->${NAME}
* @Description: ${description}
* @Author: ${USER}
* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version： 1.0
**/

设置后的效果为

这里大家根据各自的项目要求来编写模板内容，需要使用到什么参数，如时间参数${DATE}，在上图的Description中可以找到你需要的各种参数。

配置好以后，再新建一个类的时候，会提示你输入类的描述信息，如下：

创建类时生成的类注解的效果图如下：

 到此类注解模板介绍完成。

二、方法注解模板配置

步骤一：打开Idea，在菜单栏中找到 File ->setting -> Live Templates 后点击，出现以下界面：

步骤二：此时我们需要创建自己的模板组，所以我们点击图中的 + 按钮（在右边），选择  Template Group...，输入我们自定义方法模板组的名称，然后点击ok，效果图如下：

 

步骤三：此时我们已经成功创建了自定义模板组，此时选中模板组，然后再次点击右边的 + 按钮，选择 Live Template，效果图如下：

 

 我们通过修改图中的 Expand with 修改默认快捷键为Enter（原来默认的为Tab，看个人习惯可改可不改），Abbreviation参数来设置我们自定义方法模板的快捷键 ，通过修改Description来标明模板用途，这里我使用 * 作为方法模板快捷键，同时我在 Template text 中自定义了我的方法注解模板，效果图如下：

模板内容如下：

/** 
* @Description: $description$ 
* @Param: $params$ 
* @return: $returns$
* @Date: $date$ 
**/ 

步骤四：此时我们点击图中最下方的  Define 按钮来设置模板作用的语言范围，这里我们选择Java后，效果图如下：

选择后java后

步骤五：点击 Edit variables 按钮，弹出参数配置页面（参数是指我们模板中带有${}的变量）

此时我们将returns选择Expression，在下拉框中找到返回值的变量，date同理，效果图如下：

 这里我们需要重点说一下params的配置，如果我们想要的效果是多个入参能够一行一个的展示，我们需要通过groovy脚本语言来定义params中的Default value，如上图，将脚本语言粘贴进去就可以了，脚本语言内容如下：

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())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())

 然后一路点击ok，我们就将方法注解模板配置成功了，此时我们通过在类的方法前面或者方法体里面输入模板名（这里我们输入的是* ），然后按下Enter键，就能够得到我们想要的方法注解了，效果图如下：

到此类注解和方法注解模板介绍结束。
 

补充说明：这种方式的方法注释模板，如果在方法前自动生成，param参数会获取不到，但是放到方法体里面就可以获取到参数（估计是groovy脚本语言在方法体外获取不到param的原因），在实际运用中只是需要复制一下贴到方法体前面就可以，稍显麻烦。