域名信息模板如何创建-IDEA实用技巧：类文件作者信息/设置注释模板

115资源网 12小时前模板商城浏览：1 0

在这个新春佳节里域名信息模板如何创建，首先祝大家新年快乐！ 2020年初的肺炎病毒灾难打乱了很多人的安排，武汉人民也付出了巨大的牺牲。当我在武汉域名信息模板如何创建，逛遍各个热干面摊的时候，衷心祝愿武汉好运！

春节期间，我每天都待在家里休息，本该上班的日子被一定程度的推迟了，于是我就趁着这段时间开始整理编码标准。评论是一个无法绕过的障碍。很多人不知道怎么写评论，甚至知道怎么写评论但是写的评论却没有标准。

由于现在越来越多的团队使用IDEA作为代码编辑器，我们可以使用IDEA中的注释模板来规范团队注释，使整个团队的注释遵循统一的格式，提高生产环境中的代码质量。

文章目录

1.类名标注模板

创建一个新类意味着你要对其负责。如果一个类文件没有任何标志性的注释，那么代码审查就会很不方便。

虽然你可以反驳我说可以通过版本控制提交记录来查看这个类文件是谁创建的，但是通过写注释来标识是谁创建的，就可以准确的知道该文件是否是在某年某月创建的。好点吗？

如果规定每个人都必须通过写类注释的方式写上自己的名字和创建日期，上面的问题就可以解决，但是每个人的注释风格差异很大，最终的效果还是很差。这时候，我们就可以推动统一类注解模板的设置。

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

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

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

表示作者为 Vainycos，描述要求您在创建新班级时输入，日期会自动填写当前时间。

设置完成后，点击右下角的应用，关闭设置界面。

我们尝试新建一个Test类，效果如下：

1.新建一个java文件，命名为Test

2.提示输入描述信息

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

2.方法名注释模板

每个方法代表一个函数，包括输入和输出。

如果给你一个纯代码函数，输入内容是什么，输出结果是什么？你可能要读完整个代码才能理解，甚至读完整个代码你也可能无法理解。

这时候如果有一个基本的描述注释内容，就是说输入两个整数，输出两个整数之和。那么你就不需要了解代码的实现了。反正你明白了，只要给这个函数两个数字，两个数字都必须是整数，最后返回的结果就是这两个整数之和，这样就大大节省了理解的时间。打码时间。

同样，我们可以使用IDEA的注释模板来实现对方法名称的注释格式限制。

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

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

输入自定义名称。没有特殊规定。只要符合命名规范，不出现中文即可，比如我这里命名为myTemplates。

创建新的模板组后，用鼠标选择新创建的模板组，单击右上角相同位置的+号，然后选择1.Live Template。

我们主要关注上图中红色标记的三个地方。第一个表示快捷键的字符标识。这里我们将其设置为*，以方便我们后续的快捷调用。

第二部分主要描述模板的说明文字，可以简单描述一下。

第三处是核心设置的模板处。我这里设置为：

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

注意第一行注释特地写了less /*，因为后面我们快捷键调用的效果是输入/**然后按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;
    }

三、总结

使用工具来实现注释规范是统一注释格式的绝佳方式，以方便将来的代码审查，提高团队的代码质量和规范。

参考：

相关文章