IntelliJ IDEA 配置 Java 类全局注释模板操作指南

IntelliJ IDEA 配置 Java 类全局注释模板操作指南

在正规的企业开发团队中，配置全局的类注释模板是提升代码规范性的标准操作。通过在 IntelliJ IDEA 中进行配置，可实现每次新建 Java 类时自动生成包含日期、作者等信息的标准化注释。

以下是具体的配置步骤：

第一步：打开设置面板

1. Windows/Linux 系统 ：在 IDEA 顶部菜单栏，点击 File -> Settings。
2. macOS 系统 ：点击 IntelliJ IDEA -> Preferences。
3. 定位功能 ：在左侧搜索框输入 Templates，或依次展开 Editor -> File and Code Templates。

第二步：找到全局文件头配置

1. 在右侧设置区域，点击中间的 Includes 标签页。
2. 在列表中选择 File Header 选项，此时右侧会显示编辑框。

第三步：编辑并粘贴模板代码

将所需的注释模板粘贴进右侧的编辑框中。建议使用包含动态变量的纯净模板，以避免后续手动修改的繁琐。
推荐模板代码如下：

/**
 * @description: TODO
 * @author: 你的名字 (或使用变量 ${USER} 自动读取系统用户名)
 * @date: ${DATE} ${TIME}
 */

变量说明：

• ${DATE}：文件创建时的日期（例如：2026-03-19）。
• ${TIME}：文件创建时的具体时间。
• ${USER}：当前计算机的用户名。
• TODO：功能描述占位符，新建类后需替换为实际的类描述。

第四步：保存并验证

1. 点击右下角的 Apply，随后点击 OK 保存设置。
2. 在项目中右键点击 New -> Java Class 创建一个新的测试类。
3. 检查类文件上方是否已自动生成包含当前日期和作者信息的注释头部。