IDEA 为类和方法自动生成注释

一、添加类注释：

(1)、方法一：

如图，在类注释中可以应用相关变量，这样新建一个类时就能生成指定的注释。

效果图：

(2)、方法二：

如图也可以使用上图方式给类加上注释，与第一种不同的是，这种方式在创建类时会弹出提示框输入 discription 。

效果图：

类注释模板：

/*
 * @author:CG
 * @date:${YEAR}/${MONTH}/${DAY} ${TIME}
 * @discription:${discription}
 */

二、添加方法注释：

第一步：

第二步：

1. 模板名 (后面再介绍其作用)
2. 当前模板的描述信息。
3. 模板，其中可以引用一些变量。
4. 设置变量参数，就是设置步骤 3 中的变量值。
5. 快捷键，以哪种快捷键生成注释，IDEA 默认是 Tab 键，可以改为其他，后面介绍。
6. 设置模板应用场景。

在 IDEA 中生成注释的方式是 /* + 模板名 + 快捷键，我这儿就是 /* + * +Tab ，如果你的模板名为 note ,那么你生成注释的方法是 /* + note + Tab.

注释模板：

*
 * @author: CG
 * @description: $description$
 * @param: $params$
 * @date: $date$
 * @time: $time$
 * @return: $return$
 */

因为在生成注释时，已经输入了 ’ /* ’ 所以模板前面不需要 ’ / ’ 了。

设置变量：

点击 4 中的按钮，进入上图提示框，初始为空，按照参数名字，找到对应的表达式即可，这样在生成注释时，就能自动获取到对应参数的值。

设置快捷键：

点击 5 中的下拉框，如图：

选择自己喜欢的快捷键方式，默认是 Tab 键。

设置应用场景：

点击 6 中的 Define （如果曾经修改过，则显示为Change而不是Define）:

选择 Everywhere.

完成以上操作，就可以使用对用的方式生成注释了。

第三步：

在方法上面，输入设置的生成模板方法：

如果注释上的变量值都能正确的获取，就设置表明成功了。