IDEA注释模板设置：类和方法

一、首先我们来设置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版本，可以直接先写上1.0，后期有需要可改

附上源码：

/**
    *@ClassName ${NAME}
    *@Description TODO
    *@Author ${USER}
    *@Date ${DATE} ${TIME}
    *@Version 1.0
    */

二、设置方法注释模板

使用Eclipse时我们生成注释的习惯是/**+Enter，这里我们也按照这种习惯来设置IDEA的方法注释

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

（1）新建组：命名为userDefine

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

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

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

获取方法返回值的methodReturnType(）

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

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

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

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

附上源码：

*
 * @Author lanqisen
 * @Description //TODO $end$ 
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

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

选择右侧的Edit variables按钮

 

选择每个参数对应的获取方法（在下拉选择框中选择，如上图设置即可）

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

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

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

 

（7）创建方法，在方法上面写：/*+模板名+Enter-->/**+Enter即可 

原文：https://blog.youkuaiyun.com/weixin_42567749/article/details/81052241