IntelliJ IDEA 高效配置：新建文件自动生成作者与时间注释

在日常开发中，统一的代码注释规范不仅能提升代码可读性，也方便追溯代码的变更历史。IntelliJ IDEA 提供了强大的文件模板（File and Code Templates）功能，让我们在新建 Java 类、接口、枚举等文件时，自动插入包含作者、创建时间等信息的头注释。本文将手把手教你配置这一特性，并分享若干实用技巧。

1. 为什么需要自动生成文件头注释？

规范统一：团队所有成员新建的文件都遵循相同格式，避免风格杂乱。
信息溯源 ：通过 @author 和 @date 可以快速定位最初的创建者和创建时间。
减少重复：无需手动复制粘贴注释，提高编码效率。

2. 快速配置：3 步实现自动注释

步骤一：打开文件模板设置

Windows / Linux ：File → Settings → Editor → File and Code Templates
macOS ：IntelliJ IDEA → Preferences → Editor → File and Code Templates

步骤二：编写通用文件头（Includes）

在右侧面板切换到 Includes 选项卡，选择 File Header，输入你想要的注释模板。IDEA 支持一系列预定义变量，这里先给出一个最典型的 Java 文件头示例：

java 复制代码

/**
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @description 
 */

常用变量说明：

变量	含义	示例输出
`${USER}`	当前系统用户名	`john`
`${DATE}`	当前系统日期	`2026/5/29`
`${TIME}`	当前系统时间	`14:30`
`${YEAR}`	四位年份	`2026`
`${MONTH}`	两位月份	`05`
`${DAY}`	两位日期	`29`
`${HOUR}`	小时（24小时制）	`14`
`${MINUTE}`	分钟	`30`
`${PROJECT_NAME}`	当前项目名称	`demo-project`

你也可以用这些变量自由组合日期格式，例如 ${YEAR}-${MONTH}-${DAY} 会生成 2026-05-29。

步骤三：将文件头应用到具体模板

切换到 Files 选项卡，依次选择你常用的文件模板，比如 Class 、Interface 、Enum 等。

确保模板中在 package 声明之后、类定义之前，有以下引用语句：

java 复制代码

#parse("File Header.java")

完整的 Class 模板通常长这样：

java 复制代码

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
}

点击 Apply 保存。现在新建一个 Java 类试试，文件顶部会自动生成你刚才定义的头注释。

3. 固定作者名：告别"Administrator"

有时 ${USER} 默认获取的是操作系统用户名（如 Administrator 或 zhangsan），而我们更希望显示统一的作者名（如 Zhang San），这里提供两种解决方案。

方案一：直接写死（快捷方式）

在 File Header 中不用变量，直接写：

java 复制代码

/**
 * @author Zhang San
 * @date ${DATE} ${TIME}
 */

方案二：修改 IDE 启动参数（更通用）

通过自定义 user.name 系统属性，让 ${USER} 输出固定值，而不影响操作系统本身的用户名。

点击 Help → Edit Custom VM Options，IDEA 会自动打开一个 VM 配置文件（如果没有会提示新建）。
添加一行：
复制代码
```
-Duser.name=Zhang San
```
重启 IDE，之后 ${USER} 将固定为 Zhang San。

这种方法对多模块、多语言模板都有效，一劳永逸。

4. 扩展：更多文件类型的模板配置

IDEA 文件模板支持所有新建文件类型，你完全可以根据不同语言定制注释风格。

Java 接口（Interface）

java 复制代码

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public interface ${NAME} {
}

XML / HTML 文件

Includes 中可直接编写与文件类型匹配的注释，例如 XML 文件头：

xml 复制代码

<!--
  @author ${USER}
  @date ${DATE}
-->

然后在 Files 的 XML 模板中通过 #parse("File Header.xml") 引用即可（注意后缀需要与实际 Include 名称一致）。

Kotlin / Python / JavaScript

原理相同，只需要注意不同语言的注释语法即可。例如 Python 模板：

python 复制代码

# @author ${USER}
# @date ${DATE}

在 Includes 中添加一个 File Header.py，再到对应文件模板中 #parse 引入。

5. 为已有文件批量添加注释

上述配置只对新建文件生效。如果想对项目中已有文件统一添加头注释，推荐两种方法：

方法一：正则表达式替换

快捷键 Ctrl+Shift+R（全局替换），勾选"Regex"，在文件开头匹配并插入注释。这种方式适合简单场景，但要注意不同文件的格式差异。
方法二：Copyright 插件（IDE 内置）

进入 Settings → Copyright → Copyright Profiles，创建一个 Profile 并定义注释格式，然后右键项目/文件夹 → Update Copyright，即可批量添加。这种方式更强大，支持排除特定文件、增量更新等。

6. 技巧与注意事项

避免重复添加 ：模板中的 #parse 指令会原样插入 Include 内容，如果在 Include 和具体模板中都写了注释，会出现双份，检查时务必注意。
作者信息与版本控制 ：如今 Git 等版本控制系统已记录每次提交的作者，物理文件中的 @author 仍有其"初始创作者"的标识作用，建议保留。
团队规范 ：模板配置完后，可将 .idea/fileTemplates 目录提交到 Git 仓库（需谨慎处理用户本地差异），或统一编写团队文档，确保成员配置一致。
动态日期更新 ：${DATE} 只在文件创建时替换一次，之后即使修改类文件，日期也不会变化------这恰好符合"创建日期"的语义。

总结

通过 IDEA 的文件模板功能，我们能够将机械的注释编写变为自动生成，既保证了注释风格的一致性，也提升了开发效率。无论是个人项目还是团队协作，这都是一个投入小、回报大的生产力技巧。赶紧打开你的 IDEA，花两分钟配置起来吧！

延伸思考 ：你还可以利用模板中的 ${PROJECT_NAME}、自定义变量等，生成更丰富的文件头部信息，甚至结合 Live Templates 实现更高级的代码片段自动化。

good day！！！