news 2026/9/2 20:17:36

如何让你的代码更规范:在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/9/2 2:28:00

30、Shell脚本编写与Bash安装指南

Shell脚本编写与Bash安装指南 1. Shell脚本编写最佳实践 在编写Shell脚本时,我们不仅要让代码完成任务,还要确保其具有可维护性,遵循良好的编程实践。 1.1 代码可读性 编写脚本时,代码的可读性至关重要。例如,六个月前编写的100行脚本,现在可能自己都难以理解其功能。…

作者头像 李华
网站建设 2026/9/1 10:16:03

31、Bash使用与相关Shell比较全解析

Bash使用与相关Shell比较全解析 1. Bash配置与测试 在Bash的使用过程中,配置和测试是重要的环节。 - 配置选项 : disabled-builtins 和 xpg-echo-default 选项默认是禁用的,其他选项则是启用的。很多其他的Shell特性可以通过修改 config-.top.h 文件来开启或关闭…

作者头像 李华
网站建设 2026/9/1 12:49:23

33、Bash 环境变量、操作符及选项全解析

Bash 环境变量、操作符及选项全解析 在使用 Bash 进行编程和操作时,了解其内置的环境变量、测试操作符、 set 选项、 shopt 选项以及 I/O 重定向等知识至关重要。以下将详细介绍这些内容。 内置 shell 变量 Bash 3.0 中有一系列内置的环境变量,这些变量在不同的场景下…

作者头像 李华
网站建设 2026/9/1 20:47:21

前端环境配置(nvm、nodejs、npm)

一、安装nvm 1. 下载vnm url: https://nvm.uihtm.com/doc/download-nvm.html 2. 解压文件后双击exe文件进行安装 ​ ​ 3. 选择nvm的安装地址,我是安装在D:\App\nvm ​ 4. 选择nodejs的安装地址,我是安装在C:\Program Files\nodejs ​ 5. 点击next 一直…

作者头像 李华
网站建设 2026/9/2 13:38:34

RK3588语音AI部署终极指南:算子兼容性深度优化与实战解决方案

RK3588语音AI部署终极指南:算子兼容性深度优化与实战解决方案 【免费下载链接】sherpa-onnx k2-fsa/sherpa-onnx: Sherpa-ONNX 项目与 ONNX 格式模型的处理有关,可能涉及将语音识别或者其他领域的模型转换为 ONNX 格式,并进行优化和部署。 …

作者头像 李华
网站建设 2026/9/2 13:18:19

EmotiVoice语音好奇感模拟促进知识探索

EmotiVoice语音好奇感模拟促进知识探索 在AI助手越来越频繁地出现在我们生活中的今天,一个明显的问题浮出水面:为什么大多数语音交互仍然让人感觉“冷冰冰”?无论是车载导航的一板一眼,还是智能音箱千篇一律的回答,用户…

作者头像 李华