JAVA类和方法的注释自定义自动生成（IDEA）

JAVA类和方法的注释自定义自动生成（IDEA）

自动生成类和方法的模版能够方便别人阅读你的代码，也能让之后的自己更好的的回想起代码的意思。

一、IDEA中设置类注释

1、路径：File——>settings——>Editor——>File and Code Templates——>Files——>Class（能设置类的注释自然也能设置接口的，要设置接口注释选择Interface即可）

1、类的模版

（1） @ClassName：设置类名，${NAME}能获取到创建的类名

（2）@Description：写有关于类的描述

①TODO：代办事项的标记，一般生成类或方法都需要添加描述
②${description}：能让你在创建类的时候再次弹出一个输入框，输入这个类的描
述，能让你不用再建好类之后再去写描述，会方便一些

（3）@Author :输入写当前这个类的作者的名字，你可以在这里默认添加你的名字

（4）@Create设置创建类的日期和时间

${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}：是输出日期的格式

（5）@Version;设置版本号

1.0：一般新创建的类都是1.0版本，这里直接写他也可以

/**
* @ClassName: ${NAME}
*
* @Description: TODO ${description}
*
* @Author: 作者的名字
*
* @Create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*
* @Version 1.0
**/

2、类模版的显示效果

二、IDEA中设置方法注释

1、路径：File——>settings——>Editor——>Live Templates——>点击右边加号为自己添加一个Templates Group （我的命名为Test）
（1）点击右边加号为自己添加一个Live Template，给自己的模版命名，IDEA生成注释的默认方式是：/*+模板名+快捷键图中将快捷键改成了Enter,那么方法生成的方式为:

/*+Enter或 /***+Enter

1、方法的模版

我是定义了两个方法的模版的*对应的是没有返回值的方法，**对应的是有返回值的方法

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

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

（2）@Description：写有关于方法的描述

$description$ ：设置的方法描述的变量名

（3）@Param：写方法的参数

$params$ ：设置的参数的变量名

（4）@return：写方法的返回值

$returns$ ：设置的返回值变量名

（5）@Author :输入写当前这个类的作者的名字，你可以在这里默认添加你的名字
（6）@Create设置创建类的日期和时间

$date$ $time$：设置的天数和时间的变量名

（7）需要设置模版的应用场景也就是它的作用域

点击模板页面最下方的define，来设置将模板应用于那些场景，全选即可，要
是真要划分到java这一块就选择EveryWhere——>Java
（修改过后下面的define就变成了change）

（8）设置参数的获取方式(必须先完成上方的设置才可以获取到参数)，点击Enter veriables，按照我的截图，在下拉框里面选择设置即可

*

* 
* @Description: $description$ 
* @Param: $params$ 
* @Author: 作者的名字
* @Date: $date$ $time$
*/ 

**

* 
* @Description: $description$ 
* @Param: $params$ 
* @return: $returns$ 
* @Author: 作者的名字
* @Date: $date$ $time$
*/ 

2、方法模版的显示效果

创建方法，在方法上面写：/*+模板名+Enter或者/**+Enter即可

*

**