怎么用IDEA快速生成自己的注释

今天写一期有关于IDEA使用技巧的文章吧，就是如何设置类注释和方法注释。那为什么会有这样的想法呢？ 你看：


对于一个强迫症患者来说，下划波浪线简直就不可容忍嘛！！！

然后我发现这其实是一个插件带来的结果，Alibaba Java Coding Guidelines（阿里巴巴编程规范），它要求注释应该使用javadoc形式的注释，像这样

但是又不能卸载这个插件，毕竟还是非常好用的，叮！
那么我们还是来看一看怎么在IDEA中设置类和方法的注释吧。

一、设置类注释

如何设置

点击File–>Settings–>Editor–>File and code Templates–>Files–>Class，这里只是说明如何在java类中添加注释，其他文件类型类似。

模板代码如下：

/**
* @ClassName : ${NAME}  //类名
* @Description : ${description}  //描述
* @Author : ${USER} //作者
* @Date: ${DATE}  ${TIME}
*/

如果觉得上面的字段种类不够用，可以自行添加字段，参考模板下方的description

如何添加类注释

将上面的模板正确添加之后，在下次创建一个类，输入类名以后会出现

点击确认以后就会给类添加注释了，如下图：

看起来是不是舒服了很多。

二、自定义模板设置类注释

上面的设置是在创建类的时候创建的注释，还必须要输入description，有的同学说假如我就写一个Demo测试一个小功能还需要写description这么麻烦？
我们也可以自定义快捷键和模板来设置注释。
点击File–>Settings–>Editor–>Live Templates

设置分组名为MyGroup，选中组名，点击右侧的+号，添加Live Template

类注释模板：

**
* @ClassName : $NAME$ 
* @Description : $description$ 
* @Author : $user$
* @Date: $date$ $TIME$ 
*/

这里的变量格式和上面的不太一样，注意一下。
在Edit variables里这样设置：

设置后以后就是这个样子：

在类中使用：输入/cc+tab就可以生成注释了

这样就可以跳过创建类的繁琐过程了，nice！

三、自定义模板设置方法注释

上面的步骤都是类似的，就不赘述了，提供一个模板参考吧。

**
* @Param : $param$ 
* @Description : $description$ 
* @Author : $user$
* @Date : $date$ $TIME$ 
* @return $return$  
* @throws $throws$  
*/

结果样例：

可以根据个人需求来增添字段！

终于写完咯，如果大家有什么建议和意见欢迎留言和私信！