IDEA 类和方法注释模板设置

DEA 自带的注释模板不是太好用，我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家，我不是专业玩博客的，写这篇文章只是为了让大家省事。

这里设置的注释模板采用 Eclipse 的格式，下面先贴出 Eclipse 的注释模板，我们就按照这种格式来设置：

类注释模板：

方法注释模板：

一、首先我们来设置 IDEA 中类的模板：（IDEA 中在创建类时会自动给添加注释）

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择 Class 文件（当然你要设置接口的还也可以选择 Interface 文件）

（1）$NAME：设置类名，与下面的${NAME}一样才能获取到创建的类名

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

（3）$USER、${DATE}、$TIME：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在绿色框标注的位置，比如你想添加项目名则可以使用${PROJECT_NAME}

（4）1.0：设置版本号，一般新创建的类都是 1.0 版本，这里写死就可以了

2、效果图展示

二、设置方法注释模板

IDEA 还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，使用 Eclipse 时我们生成注释的习惯是

/**+Enter，这里我们也按照这种习惯来设置 IDEA 的方法注释

1、File-->Settings-->Editor-->Live Templates

（1）新建组：命名为 userDefine

（2）新建模板：命名为*

因为 IDEA 生成注释的默认方式是：/*+ 模板名 + 快捷键（比如若设置模板名为 add 快捷键用 Tab，则生成方式为

/*add+Tab），如果不采用这样的生成方式 IDEA 中没有内容的方法将不可用，例如获取方法参数的 methodParameters(）、

获取方法返回值的 methodReturnType(）

（3）设置生成注释的快捷键

（4）设置模板：模板内容如下

注意第一行，只有一个而不是/

在设置参数名时必须用$参数名$的方式，否则第五步中读取不到你设置的参数名

*
 * @Author chengpunan
 * @Description _//TODO $end$_ * @Date $time$ $date$
 * @Param $param$
 * @**return** $return$
 **/
​

如果使用/生成的模板注释将会是如下效果：所以我们要去掉最前面的/

（5）设置参数的获取方式

选择右侧的 Edit variables 按钮

选择每个参数对应的获取方法（在下拉选择框中选择即可），网上有很多教程说获取 param 时使用脚本的方式，我试过使用脚本

的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数

（6）设置模板的应用场景

点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择 EveryWhere-->Java 即可

（如果曾经修改过，则显示为 change 而不是 define）

（7）效果图

创建方法，在方法上面写：/*+ 模板名 +Enter-->/**+Enter