IDEA设置类、接口和方法相关注释

    最近一段时间都是在忙工作上项目的事情，发现很多类及方法的定义又多又杂，很容易相互弄混淆，定义相关的注释能够增强代码的可读性。而本人之前只是在IDEA中设置了类的注释，今天将类、接口和方法的相关注释一起进行汇总，总结如下：

1.类及接口注释

打开我们的IDEA，依次选择 File | Settings | Editor | File and Code Templates

然后点击左边中间框中的Class，弹出左边框，右边的四个红色箭头是我们需要补充的内容：分别表示类名、类描述、作者名字和类的创建时间。

/**
*@ClassName: ${NAME}
*@Description: 
*@Author: YourName
*@Date: ${DATE}
*/

而接口的注释也跟类的注释相似，只需要将右边红色箭头的类名称更换成接口名称即可。

/**
*@InterfaceName: ${NAME}
*@Description: 
*@Author: YourName
*@Date: ${DATE}
*/

因为在项目当中，写得最多的莫过于是类和接口，枚举类也偶尔用到，如果大家有需求，按照上述的方法，稍作修改即可。最后添加好注释之后不要忘记点击右下角的Apply，需要点击一下才能够应用成功哦！

2.方法注释

打开IDEA，依次选择 File | Settings | Editor | Live Templates

然后点击右上角的"+"号，选择标记红色箭头的第2个选项，选择Template Groups… ，这样是为了新建一个组别，以便于我们后续的添加方法注释。

点击之后，给我们的组别取名字，我这里取的名字为：MyMethods，点击OK！

新建完组别之后，继续点击右上角的“+”号标记红色箭头的第1个选项Live Template

点击完之后，有以下途中六个点需要我们注意：
①缩写：以便于我们后续用快捷键。默认的是“注释的缩写+Tab”得到所生成的注释；
②描述：可以在这里写成是“方法注释”；
③注释的内容：跟上述写类及接口注释类似；
④定义的范围：选择需要定义的注释范围，即作用域；
⑤编辑相关变量：根据自己需求的实际情况进行编辑；
⑥Apply：所有的操作做完以后，不要忘记点击应用。

注意当中的前三点完成之后为：①add；②方法注释；③相关的注释内容。 如下图所示：

④定义的范围： 选择Everywhere选项，作用在IDEA中所有的位置。

⑤编辑相关的变量： 我这里只使用了一个日期方法，如果大家还有别的想添加的内容，可以现在 ③ 中添加，然后再在 ⑤ 中编辑相关的方法，就能达到相应的效果。

⑥Apply： 不要最后忘记点击Apply才能应用到我们的程序当中哦！

3.效果展示

（1）类注释：

（2）接口注释：

（3）方法注释：通过输入“add+Tab”进行添加


以上是一些小小的关于IDEA注释方面的总结，希望能帮助到各位小伙伴们啦！！！
路过的小伙伴，可以点赞+关注一波呀~本人将会持续更新相关学习博文，感谢您的支持哦！！！