news 2026/6/12 21:17:44

如何让你的代码更规范:在IDEA中设置作者和日期等文件模板

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
如何让你的代码更规范:在IDEA中设置作者和日期等文件模板

在团队协作或者日常开发中,规范的代码注释不仅能让代码可读性大大提升,还能方便后续追溯代码的编写人和创建时间。IntelliJ IDEA 支持自定义文件模板,我们可以通过简单的设置,让新建的 Java 类、接口等文件自动带上作者、日期、描述等注释信息,告别手动编写的麻烦。今天就来手把手教你配置这个实用功能!

一、 打开文件模板设置界面

1. 启动 IDEA,点击顶部菜单栏的 File -> Settings(Windows/Linux 系统);如果是 Mac 系统,点击 IntelliJ IDEA -> Settings。

2. 在弹出的设置窗口中,依次展开 Editor -> File and Code Templates,进入模板配置页面。

3. 在页面右侧的 Files 标签下,找到并选中 Class(Java 类模板),后续我们主要对这个模板进行修改;同理,你也可以对 Interface、Enum 等模板做相同配置。

二、 自定义模板内容,添加作者和日期

1. 在模板编辑区域,默认会有一段模板代码,我们需要在类注释的位置添加作者、日期等变量。

2. 在类定义上方插入以下注释模板(可根据需求调整格式):

java

/**

* @author ${USER}

* @date ${DATE} ${TIME}

* @description ${description}

*/

3. 完整的 Java 类模板示例如下:

java

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

/**

* @author ${USER}

* @date ${DATE} ${TIME}

* @description ${description}

*/

#if (${NAME} != "")public class ${NAME} {

public static void main(String[] args) {

}

}#end

4. 关键变量说明

- ${USER} :自动填充当前 IDEA 的登录用户名;

- ${DATE} :自动填充文件创建的日期,格式默认为 yyyy/MM/dd ;

- ${TIME} :自动填充文件创建的具体时间,格式默认为 HH:mm ;

- ${description} :自定义变量,新建类时会弹出输入框,让你填写类的功能描述。

三、 调整日期和时间的显示格式(可选)

如果默认的日期时间格式不符合你的需求,可以手动修改格式:

1. 在 File and Code Templates 页面,切换到 Includes 标签。

2. 找到并选中 File Header 选项,在编辑区域可以直接修改日期时间的格式,例如将 ${DATE} 改为 ${DATE, yyyy-MM-dd} ,时间就会以 2025-12-17 的形式显示。

四、 验证模板效果

1. 点击设置窗口的 Apply -> OK 保存配置。

2. 在 IDEA 中新建一个 Java 类:右键点击项目包 -> New -> Java Class,输入类名后回车。

3. 此时新建的类文件会自动带上配置好的注释模板, @author 和 @date 会自动填充内容, @description 需要手动输入描述信息,完美实现规范化注释!

五、 拓展:为其他文件类型配置模板

除了 Java 类,你还可以对 Interface、Enum、Annotation 等文件模板进行同样的配置,只需要在 Files 标签下选中对应的模板,添加相同的注释内容即可,让整个项目的文件注释风格保持统一。

总结

通过设置 IDEA 的文件模板,我们可以实现注释的自动化生成,既节省了手动编写的时间,又能让团队代码风格更规范。这个小技巧对于 Java 初学者来说,是提升代码整洁度的必备操作,赶紧动手配置起来吧!

如果觉得这篇教程有用,欢迎点赞收藏~ 后续还会分享更多 IDEA 实用小技巧

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/6/10 17:00:38

Memobase项目快速上手:构建智能记忆系统的完整指南

项目核心价值与定位 【免费下载链接】memobase Profile-Based Long-Term Memory for AI Applications 项目地址: https://gitcode.com/gh_mirrors/me/memobase Memobase是一个革命性的用户记忆管理系统,专为生成式AI应用打造持久化用户档案。无论您正在开发智…

作者头像 李华
网站建设 2026/6/13 0:25:58

一键部署EmotiVoice镜像,快速接入GPU算力提升语音生成效率

一键部署EmotiVoice镜像,快速接入GPU算力提升语音生成效率 在内容创作与人机交互日益智能化的今天,用户对语音合成的需求早已超越“能听清”的基本要求,转向“有情感、像真人”的高阶体验。无论是虚拟主播的情绪起伏,还是智能助手…

作者头像 李华
网站建设 2026/6/11 15:58:38

ReadCat电子书阅读器:打造极致沉浸的数字阅读体验

ReadCat电子书阅读器:打造极致沉浸的数字阅读体验 【免费下载链接】read-cat 一款免费、开源、简洁、纯净、无广告的小说阅读器 项目地址: https://gitcode.com/gh_mirrors/re/read-cat 在数字化阅读日益普及的今天,如何选择一款真正懂你的电子书…

作者头像 李华
网站建设 2026/6/12 13:32:18

5分钟快速掌握NVIDIA容器工具包完整安装指南

5分钟快速掌握NVIDIA容器工具包完整安装指南 【免费下载链接】nvidia-container-toolkit Build and run containers leveraging NVIDIA GPUs 项目地址: https://gitcode.com/gh_mirrors/nv/nvidia-container-toolkit 想要在容器环境中充分发挥NVIDIA GPU的强大计算能力吗…

作者头像 李华
网站建设 2026/6/11 4:09:24

终极Git图形化客户端:SourceGit v2025.04完全使用指南

终极Git图形化客户端:SourceGit v2025.04完全使用指南 【免费下载链接】sourcegit Windows GUI client for GIT users 项目地址: https://gitcode.com/gh_mirrors/so/sourcegit 还在为复杂的Git命令而烦恼吗?SourceGit v2025.04作为一款专业的Git…

作者头像 李华
网站建设 2026/6/12 2:41:59

卡尔曼滤波终极指南:5种工程解法深度对比与实战调优

卡尔曼滤波终极指南:5种工程解法深度对比与实战调优 【免费下载链接】Kalman-and-Bayesian-Filters-in-Python Kalman Filter book using Jupyter Notebook. Focuses on building intuition and experience, not formal proofs. Includes Kalman filters,extended K…

作者头像 李华