author-头文字注释

最新推荐文章于 2023-11-30 16:40:56 发布

满Jans

最新推荐文章于 2023-11-30 16:40:56 发布

阅读量889

点赞数

分类专栏： java进阶之路文章标签： java

本文链接：https://blog.csdn.net/qq_43369336/article/details/120303073

版权

3 篇文章 0 订阅

订阅专栏

本文详细介绍了在IntelliJ IDEA中如何设置代码文件的头注释模板，包括@Author、@Create、@FileName、@Description等属性的使用，并提供了多种注释样例，帮助开发者规范化代码编写。

摘要由CSDN通过智能技术生成

在进入公司后，会有代码编写规范。有公司会让你加入头文字注释有的不会，主看公司下面小编为大家介绍IDEA中设置author和参数介绍。

1、File —> settings

在这里插入图片描述
2、Editor —> Editor —> File and Code Templates —> Includes —> File Header

@Author 创建人名

@Author: ${USER} // ${USER} 是取主机名

可自定义: 创建人：张三

@create: ${DATE} ${TIME}

${DATE}：年月日

${TIME}：秒

可自定义：创建时间：${DATE}

@FileName: ${NAME}

可自定义：类名称：${NAME}

@Description: ${DESCRIPTION}

可自定义：说明：${DESCRIPTION}

@version：版本号

@program:自动获取项目名字

第一种

/**
 * 说明: ${DESCRIPTION}
 * 类名称: ${NAME}
 * 创建人: xxx
 * 创建时间: ${DATE} 
 */

填入 DESCRIPTION 时在创建类后会弹出，写上类的功能描述即可
在这里插入图片描述

第二种

/**
*@author ${USER}
*@create ${DATE} ${TIME}
*/

第三种

/**
*Created by Intellij IDEA.
*User:  ${USER}
*Date:  ${DATE}
*/

第四种

/**
*@Created by ${USER} on ${DATE}.
*/

第五种

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: xxx
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

关注