（必看）IDEA在类上和方法上添加Javadoc文档注释，图文详解_idea javadoc注释

IDEA在类和方法上生成文档注释

idea作为越来越多程序员使用的开发工具，平时的代码注释也非常的关键，下面介绍一下类上注释和方法上注释，方便大家的开发配置，同时也为自己以后配置留一份记录（毕竟每次换环境都需要重新配置一遍）

一、在类上生成文档注释（在接口上生成同理）

1. File–>settings–>Editor–>File and Code Templates–>Files–>Class
2. 在模板上加入文档注释模板，使用效果如下图 ；

/**
  *@ClassName ${NAME}
  *@Description TODO
  *@Author ${USER}
  *@DATE ${DATE} ${TIME}
  *@Version 1.0 
*/
1
2
3
4
5
6
7

二、在方法上生成文档注释

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$
 **/
1
2
3
4
5
6
7

5. 设置该模板在哪些文件生效，选择下方的define-everywhere-java，设置只在java文件中生效

6. 选择右侧的Edit variables按钮，进行如下配置

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