IDEA添加文档注释

IDEA

IDEA的注释有三种，分别为单行注释。多行注释和文档注释。
在编写代码时，我们经常添加文档注释，来记录代码的作用。
本文介绍三种常用的文档注释。

文档注释

在创建文件的时自动添加的注释内容，声明该文件的作用和创建时间。
打开设置

找到相应设置

在代码内容中输入

/**
* 功能描述
*
* @author ${USER}
* @date ${YEAR}/${MONTH}/${DAY}  ${TIME}
*/

方法注释：在方法里添加的注释。在方法外的话，无法获取参数和返回值。包括创建时间、创建人和作用。
还是打开设置

点击创建自己的Group随意命名。之后在点击自己创建的包，点击 第一个Live Template

按照图片添加相应的内容

代码

/**
 * @Author: $user$
 * @Date: $date$ $time$
 * @Param $param$
 * @Return $return$
 */ 

类注释：再创建类时自动添加

代码：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
*@ClassName ${NAME}
*@Description  TODO ${Description}
*@Author ${USER}
*@Date ${DATE} ${TIME}
*@Version 1.0
*/
public class ${NAME} {
}