IntelliJ IDEA为类和方法自动添加注释

阅读正文:

1、为类添加自动注释模版

File-->Settings-->Editor-->File and Code Templates

微信截图_20200114172356.png

/**
 * @author     :mengw9
 * @date       :Created By ${DATE} ${TIME}
 * @description:${description}
 * @modified By:
 * @version:     $version$
 */

此时,当你创建新的类时,就会自动生成注释了。

注意:一定要启用该模板才有效

微信截图_20200114172546.png

如果还不行,就添加如下设置:

微信截图_20200114172637.png

2、为方法添加自动注释模版

File-->Settings-->Editor-->Live Templates

微信截图_20200114172747.png

点击"+"号后,选择"Templates Group…"

微信截图_20200114172913.png

微信截图_20200114173042.png

微信截图_20200114202044.png

注意:此处一定要为刚刚的模板指定使用范围:

微信截图_20200114202144.png

例如:我是全选

注释模板填写内容参考如下:

**
 * @Description $description$
 * @Param       $params$
 * @return      $returns$
 * @Author      mengw9
 * @Date        Create by $date$ $Time$
 */

这里为什么前面少写了个斜线,个人比较喜欢这使用的方式,使用方式:/ + a + Tab

微信截图_20200114201501.png

点击Ok。

此时,在方法上方输入/ + a + Tab就可以生成注释了。

参考:https://www.cnblogs.com/mmzs/p/8858634.html

原文地址:https://www.cnblogs.com/mengw/p/12193140.html