IDEA实用技巧：设置注释模板

在这个春节里，首先祝大家新年快乐！2020年初的这一场肺炎病毒灾难打乱了许多人的安排，而武汉人民也付出了巨大的牺牲。当年在武汉混迹于各个热干面摊位的我也衷心的祝福武汉加油！
春节宅在家里每天休息，而本应早该上班的日子也进行了一定程度的延迟，于是趁着这段时间开始梳理编码规范。而注释是绕不过去的一道坎，许多人不会写注释，甚至于会写注释但是写出来的注释没有规范。
由于现在使用IDEA作为代码编辑器的团队越来越多，所以我们可以借助IDEA中的注释模板来实现团队注释的规范，使得整个团队的注释遵从统一的格式，提高生产环境下的代码质量。

文章目录

• 一、类名注释模板
• 二、方法名注释模板
• 三、总结

一、类名注释模板

新建一个类就意味着你要对它负责到底，若一个类文件没有任何标志性的注释，那就不便于进行代码审阅。
尽管你可以反驳我说，可以通过版本控制的提交记录来查看是谁新建的这个类文件，但是通过写一段注释来标识这是谁新建的，并且能够准确得知在某年某月新建的不是更好吗。
如果规定每个人都要通过写类注释的方式写上自己的名字和新建日期，固然可以解决以上问题，但是每个人的注释风格迥异，最后呈现的效果还是很差，这个时候我们就可以在团队中推广设置统一的类注释模板。

在IDEA的上方菜单栏中，通过File->Setting找到设置界面，在搜索框搜索File and Code Templates找到设置模板的地方。

如上图所示，我们就可以将鼠标指针点到Class上，右侧就会出现目前我设置的模板内容为：

/**
 * @author: Vainycos
 * @description ${description}
 * @date: ${DATE} ${TIME}
 */

表示作者为Vainycos，描述需要你在新建一个类的时候提示你输入，日期会自动填充当前时间。
设置完之后，点击右下角的Apply，并关闭设置界面。
我们尝试新建一个Test类，效果如下：
1.新建一个类名为Test的java文件

2.提示输入描述信息

3.我们设置的模板就成功实现了，在新建类的时候输入的描述信息也会被正确填充到注释内容中，日期也是当前的时间。

二、方法名注释模板

每一个方法即表示一个函数，包含了输入和输出。
如果给你一个纯代码的函数，输入的内容是什么，输出的结果是什么，只怕是要读完一整段代码才能看懂，甚至于看完了一整段代码都不一定能理解。
这个时候，如果有一段基本的描述注释内容，上面写着输入两个整型数字，输出两个整型数字的和。那你都不用去理解代码的实现，反正你明白了只要给这个函数两个数字且一定要都是整型的，最后返回的结果就是这两个整型数字的和结果，从而大大节省了理解代码的时间。
同样，我们可以借助IDEA的注释模板来实现方法名上的注释格式限定。

同样，在IDEA的上方菜单栏中，通过File->Setting找到设置界面，在搜索框搜索Live Templates找到设置方法名模板的地方。

此处需要我们新建一个自定义的私人模板文件夹，点击右上角的+号，在下拉框中选择2.Template Group模板组。

输入自定义的名字，没有特别规定，只要是符合命名规范即不出现中文即可，比如我此处命名为myTemplates

新建完模板群组后，鼠标选中新建的模板群组，右上角点同样地方的+号，这时选择1.Live Template。

我们主要关注上图中的三个标红处，第一处表示快捷键的字符标识，这里我们统一设置为*，方便我们后续的快捷调用。
第二处主要描述该模板的说明文字，可以进行简单的描述。
第三处则是核心设置的模板地方，我在这里设置为：

*
 * @author Vainycos
 * @description 
 * @date $date$ $time$
 * @param $param$
 * @return $return$
 */

注意第一行的注释特意少写/*，因为后面我们的实现快捷键调用效果是输入/**后，按一下Tab键进行自动填充以上的模板注释内容，包括了作者，描述，创建日期，输入参数，输出参数。
设置完成后记得要点一下右下角的Apply进行应用，关掉设置界面后，我们回到新建好的Test类，并实现一个整型数字加法函数，输入两个整型数，输出两个整型数的和。

public int twoNumberPlus(Integer a, Integer b) {
        return a+b;
    }

这个时候我们在方法名上方输入/**，然后按一下Tab键，会发现我们设置的方法名模板注释就自动填充上去了。

	/**
     * @author Vainycos
     * @description 
     * @date 2020/2/2 
     * @param [a, b]
     * @return int
     */
    public int twoNumberPlus(Integer a, Integer b) {
        return a+b;
    }

三、总结

通过运用工具来实现注释规范是一种极好的方法，统一注释格式方便日后的代码审阅，也提高团队的代码质量和规范。

参考资料:

• IntelliJ IDEA设置类注释和方法注释模板
• IDEA类和方法注释模板设置（非常详细）

来源：CSDN

作者：imVainiycos

链接：https://blog.csdn.net/imVainiycos/article/details/104145014