IDEA如何快速添加JavaDoc文档注释

作为程序员，添加javadoc注释可以说是必要的一步，但是每一次都自己手动添加大段内容也无疑是一件很麻烦的事情。

该文章主要做个记录，方便自己下次如果需要换环境的时候重新配置：

（这里的方法是idea自动生成的，不需要安装插件）

类、接口注释

1. File–>settings–>Editor–>File and Code Templates–>Files–>Class
2. 在模板上加入文档注释模板：

/**
  *@ClassName ${NAME}
  *@Description TODO
  *@Author ${USER}
  *@DATE ${DATE} ${TIME}
  *@Version 1.0 
*/
public class ${Name}{
    
}

完成之后以后每次创建类或者接口的时候就会自动生成注释了

方法注释

1. File–>Settings–>Editor–>Live Templates
2. 单击右侧“+”号，选择Template Group…，新建一个自定义模板组，可以使用自己的名字命名；
3. 选择该模板组，单击右侧“+”号，选择“Live TempLate”，设置“abbreviation”的值为”*”；
4. 设置模板内容：选择Temple Text，在下方输入如下代码：

*
 * @Author $user$
 * @Description //TODO
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

5. 设置该模板在哪些文件生效，选择下方的define -> everywhere -> java，设置只在java文件中生效
6. 选择右侧的Edit variables按钮，进行如下配置：

7. 使用/+刚设置的模板名（此处为我们前面设置的“ * ”）+tab（默认模板补全快捷键，在上方的“By default expand with”设置），所以此时我们使用/* + tab就能补全，效果如下:

至此，配置完成

---