news 2026/5/26 20:54:56

如何让你的代码更规范:在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/5/23 0:11:44

从零到一:手撸一个让队友追着夸的 Claude Skill

&#x1f4d6; 前置阅读&#xff1a;《Claude Skills 入门指南》 前言&#xff1a;一个让我每天节省10分钟的小发明 我们团队有个规定&#xff1a;commit message 必须按规范来。格式是 <type>(<scope>): <subject>&#xff0c;类型只能是 feat/fix/docs 那…

作者头像 李华
网站建设 2026/5/26 6:41:58

3步实现家庭AI集群智能负载均衡:Exo资源配额终极指南

3步实现家庭AI集群智能负载均衡&#xff1a;Exo资源配额终极指南 【免费下载链接】exo Run your own AI cluster at home with everyday devices &#x1f4f1;&#x1f4bb; &#x1f5a5;️⌚ 项目地址: https://gitcode.com/GitHub_Trending/exo8/exo 还在为家中设备…

作者头像 李华
网站建设 2026/5/24 13:23:24

SCPI Parser终极指南:免费开源仪器控制命令解析库完全掌握

SCPI Parser终极指南&#xff1a;免费开源仪器控制命令解析库完全掌握 【免费下载链接】scpi-parser Open Source SCPI device library 项目地址: https://gitcode.com/gh_mirrors/sc/scpi-parser 在当今自动化测试和仪器控制领域&#xff0c;SCPI Parser作为一款免费开…

作者头像 李华
网站建设 2026/5/25 2:00:25

EmotiVoice语音合成API计费模式设计思路

EmotiVoice语音合成API计费模式设计思路 在虚拟助手、数字人、有声内容创作日益普及的今天&#xff0c;用户对语音合成的要求早已超越“能说话”这一基本功能。人们期待的是富有情感、具备个性、甚至带有“人格”的声音输出——这正是EmotiVoice这类高表现力TTS引擎迅速崛起的技…

作者头像 李华
网站建设 2026/5/26 3:07:59

微积分笔记(2):数列的极限(上)

2.1 数列的极限本文旨在以通俗的语言将讲解微积分&#xff0c;尽量以零起点角度将复杂的微积分讲解明白。 引用本文内容必须注明“参考文档&#xff1a;《微积分笔记》作者&#xff1a;黄邦勇帅(原名&#xff1a;黄勇)”&#xff0c;或者注明转发出处&#xff0c;本文作者拥有完…

作者头像 李华
网站建设 2026/5/20 9:59:42

3D标签云终极指南:如何用JavaScript创建炫酷视觉特效

3D标签云终极指南&#xff1a;如何用JavaScript创建炫酷视觉特效 【免费下载链接】TagCloud ☁️ 3D TagCloud.js rotating with mouse 项目地址: https://gitcode.com/gh_mirrors/ta/TagCloud 想要为你的网站增添令人惊艳的3D视觉效果吗&#xff1f;TagCloud.js正是你需…

作者头像 李华