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

简介

通常，在创建一个新的类、接口或方法时，我们都会给它加上注释。虽然在添加注释时会花掉一小部分时间，但是在后面进行代码维护/交接时可以更快速的完成维护/交接工作。既然决定要写注释了，那就不能潦草的为了完成工作，必须能让自己以后看得懂，让同事也能看得明白。

IDEA的设置注释

新建类、接口、枚举时

在新建类、接口、枚举…时，我们可以直接让IDEA再创建文件时一并将文件注释创建好
右侧的模板代码可以根据自我喜好进行编辑，同理：接口和枚举类都可以进行同样步骤编辑，这里我的代码是：

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

根据上面编辑后，点击OK保存后我们新建一个class文件来看下效果

新建模板注释，注释类

上面的是文件新创建时才会生成相应的注释，但是我们在给以前的代码做相同的注释时，上面的方法就行不通了。此时我们需要创建一套注释模板来解决这个问题

此时点击Live Templates窗口的最右侧的+按钮，此时会出现两个选项：

1. Live Template：创建具体的模板
2. Template Group…：创建一个模板组（类似文件夹）

我们选择Template Group…这个选项，然后输入组名 classLiveTemplate 后点击OK
然后鼠标选中新建的classLiveTemplate组，再点击右侧的**+按钮**，此时选择第一项Live Template，创建一个具体的模板：
模板代码

/**
 * 类描述：
 * 
 * @ClassName $NAME$
 * @Description TODO $START$ $END$
 * @Author $USER$ 
 * @Date $DATE$ $TIME$ 
 * @Version 1.0
 */

1. abbreviation是使用模板的缩写这里我们使用/**
2. Description:是这个模板的注释，方便后面选择
3. Template text：里卖弄就添加具体的模板代码，注意这里是使用$变量$ 。
4. 第一创建时，点击底部的Define，然后勾选Java
5. 最后点击 Edit variables，这会将$变量$ 动态赋值

6. 最后设置触发模板的快捷键，默认是tab键

此时我们可以尝试下：
这是我们刚刚创建的Demo类，将注释删掉然后，敲 /** 完后 按下 tab建 ；因为我有多个模板绑定了 /** 和 tab 的组合，所以就需要选择class template，这个就是创建模板时的注释

方法模板

根据上面的同样步骤进行创建一个方法模板组和方法模板。但是再使用时有问题如图：
所以我还是使用idea(2020.1)的默认方法注释比较好用