IntelliJ IDEA 中设置类 / 接口 / 枚举等文件的创建注释模板

在 IntelliJ IDEA 中设置类 / 接口 / 枚举等文件的创建注释模板，可通过「文件代码模板」功能实现，步骤如下：

一、打开模板设置界面

打开 IDEA，点击顶部菜单栏：File → Settings（Windows/Linux）或 IntelliJ IDEA → Settings（Mac）；
在设置窗口左侧，展开 Editor → File and Code Templates；
切换到 Files 标签页（默认显示的就是常用文件模板）。

二、编辑类（Class）的注释模板

在 Files 列表中选择 Class（对应 Java 类文件）；
在右侧模板编辑区域，找到默认的类模板代码，在类定义上方添加注释模板（示例如下）：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @description: ${DESCRIPTION}
 * @author: ${USER}
 * @date: ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 * @version: 1.0
 */
public class ${NAME} {
}

三、其他类型文件（接口 / 枚举等）的模板设置

操作与「类模板」一致，在 Files 列表中选择对应的类型（如 Interface、Enum），在其模板中添加相同或适配的注释即可。
示例（接口 Interface 模板）：
Interface:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @description: ${DESCRIPTION}
 * @author: ${USER}
 * @date: ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 * @version: 1.0
 */
public interface ${NAME} {
}

Enum:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @description: ${DESCRIPTION}
 * @author: ${USER}
 * @date: ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 * @version: 1.0
 */
public enum ${NAME} {
}

四、模板中变量的说明

IDEA 会自动填充以下预定义变量：

• ${PACKAGE_NAME}：类所在的包名；
• ${NAME}：新建文件时输入的类 / 接口名；
• ${USER}：当前系统用户名；
• ${DATE}：当前日期（格式：yyyy/MM/dd）；
• ${TIME}：当前时间（格式：HH:mm:ss）；
• ${DESCRIPTION}：新建类时，IDEA 会弹出输入框让你填写类的描述（可选）。

五、自定义模板

Java Web + MyBatis 技术栈下常用的配置 / 功能文件模板：

1. generatorConfig
   是 MyBatis Generator（MBG）的配置文件模板，用于快速创建generatorConfig.xml：

• 作用：配置 MyBatis 代码生成规则（如数据库连接、实体类 / Mapper 接口 / XML 映射文件的生成路径、表与实体的映射关系等），执行后可自动生成 MyBatis 开发所需的基础代码。

2. jdbc.properties
   是 JDBC 数据库连接的属性配置文件模板：

• 作用：集中存放数据库连接参数（如数据库 URL、用户名、密码、驱动类名），项目中可通过读取该文件统一管理数据库连接信息，便于环境切换（如开发 / 测试环境）。

3. Mapper
   是 MyBatis 的 Mapper 文件模板（通常对应XxxMapper.xml）：

• 作用：快速生成 MyBatis 的 SQL 映射文件基础结构，包含根标签、基础 CRUD（查询 / 新增 / 修改 / 删除）的 SQL 标签模板，用于定义数据库操作语句。

4. mybatis-config
   是 MyBatis 的核心全局配置文件模板（对应mybatis-config.xml）：

• 作用：配置 MyBatis 的全局参数，比如数据库环境（连接池）、类型别名、Mapper 映射器注册、插件（如分页插件）等，是 MyBatis 框架的全局配置入口。

5. web
   是 Java Web 项目的部署描述符模板（对应web.xml）：

• 作用：快速生成 Web 应用的核心配置文件，用于配置 Servlet、Filter、Listener、初始化参数、欢迎页等 Web 应用的运行规则，是传统 Java Web 项目的必要配置文件。

这些模板的核心价值是：适配 MyBatis+Web 的技术栈，一键生成这些高频配置文件的基础结构，减少重复编码成本。

六、生效验证

保存设置后，新建 Java 类（New → Java Class），输入类名并填写描述（若有），即可看到自动生成的注释。