在 File and Code Templates 的 Files 标签页下修改 Class 等模板,使用 ${USER}、${DATE}、${TIME}、${PACKAGE_NAME}、${NAME} 等预定义变量生成类头注释,注意区分 Files 与 Live Templates,避免被插件覆盖。

IDEA 类头注释模板在哪改
在 File and Code Templates 里改,不是在 Live Templates 或 Editor > Inspections 里。很多人找错位置,结果改了半天没生效。
路径是:Settings > Editor > File and Code Templates > Files,找到你用的类模板,比如 Class、Interface 或 Enum —— 这些才是生成新类时套用的模板。
- 改的是「新建文件」时自动生成的内容,不是已有文件补注释
-
Includes标签页里的File Header是全局文件头(比如版权说明),它会被插入到每个模板开头,但不替代类模板自身内容 - 如果用了 Lombok 的
@Data等注解,模板里别硬写get/set方法,容易和实际生成冲突
怎么写带作者/日期的类头注释
IDEA 支持预定义变量,直接填进模板就行,不用手写或脚本拼接。关键是要用对变量名,否则显示成字面量。
常用变量:
-
${USER}:系统用户名(可手动设为中文名,在Settings > Appearance & Behavior > System Settings > User name) -
${DATE}:生成当天日期,格式如2024/06/12 -
${TIME}:生成时间,如15:23 -
${YEAR}:四位年份 -
${PACKAGE_NAME}:自动识别当前包路径 -
${NAME}:新文件名(不含扩展名),也就是类名
示例(粘贴到 Class 模板中):
/**
* @author ${USER}
* @date ${DATE} ${TIME}
* @package ${PACKAGE_NAME}
* @className ${NAME}
*/为什么改完模板新建类还是没注释
最常见原因是模板没选对,或者被其他插件覆盖。
- 确认你在改的是
Files标签页下的Class,不是Code标签页下的任何内容 - 检查是否勾选了
Enable Live Templates并误启用了某个同名模板(比如叫class的 Live Template),它会劫持新建行为 - 如果用的是 Kotlin,要改
Kotlin Class模板,Java 的Class模板对它无效 - 某些公司内部插件(如 Alibaba Java Coding Guidelines)会自带模板逻辑,优先级可能更高,得关掉或调低权重
注释里想加 Git 用户信息怎么办
IDEA 原生不支持 ${GIT_AUTHOR} 这类变量,硬写只会原样输出。真要动态取 Git 配置,得绕路。
- 可以手动在
Settings > Version Control > Git里核对Author name和Email是否正确,然后用${USER}代替——前提是本地 Git 用户名和系统用户名一致 - 不想依赖系统名?只能写死,比如
@author 张三 <zs@example.com>,但失去自动化意义 - 更灵活的做法是配合 IDE 插件(如 “Template Data Language”),但会引入额外维护成本,小团队不建议
变量不是万能的,${USER} 是最稳的选择;想自动读 Git 配置,就得接受 IDE 不原生支持这个场景。










