写代码这么多年但凡碰过 IntelliJ IDEA 的人估计都遇到过这种尴尬新建一个类文件头光秃秃的没有作者、没有日期翻开 Git 历史全靠猜或者项目里有的人类注释写着 admin有的写着 user代码评审的时候看着特别乱。其实这就是作者信息没设置好。IDEA 里所谓的“作者信息”本质上是在创建新文件时自动写入的一段模板注释它不光是面子工程更是团队协作里识别代码归属、定位问题来源的关键线索。今天就把 IDEA 设置作者信息这件事从入门到进阶完整讲一遍无论用的是 2023、2024 还是 2026.2 版本都能直接照着操作。这套内容适合所有用 IntelliJ IDEA 写 Java、Kotlin、Python 的开发者包括社区版和旗舰版用户花五分钟配置好后面受益很久。1. 为什么每个IDEA用户都应该设置作者信息1.1 作者信息不只是个签名很多人觉得文件头注释就是“好看”甚至有人嫌它碍事一上来就删干净。我见过不少项目新类创建出来是干干净净的等到三个月后出问题了你想知道这段代码是谁写的只能去 Git Blame 一行行看效率非常低。文件头注释里的作者信息本质上是代码的“出身证明”。它记录了这段代码最初由谁创建、大概在什么时间创建这是定位问题、评估代码逻辑的重要线索。尤其在多人协作的项目里看到author就能直接找到当事人问清楚当时的业务背景比翻聊天记录快得多。另外作者信息也影响代码风格和专业度。开源项目、公司内部脚手架、个人作品集凡是接触过你的代码的人第一眼看到的就是头部注释。一个规范的文件头能直接拉高别人对你代码的评价。1.2 团队协作中的实际作用有次我接手一个老项目服务端一堆枚举类、工具类头部注释乱七八糟有的写author: admin有的写created by idea还有的干脆没有。结果排查一个线上问题的时候需要确认某个配置类的修改意图硬是翻了一天 Git 记录才定位到人。从那时起我痛下决心把 IDEA 作者信息配置彻底搞清楚并且推动团队统一了模板。在代码评审里作者信息还能帮你快速识别“这段逻辑是谁的”责任归属清晰。虽然 Git 也能查到提交人但并不是每个人都有提交记录比如复制过来的文件或者通过 IDE 重构自动生成的文件Git 记录可能已经丢失了。而文件头注释作为代码的一部分会跟着文件走这是一种更持久、更直观的标记。团队协作时模板统一也很重要。大家用一套作者格式代码看起来整齐检索也方便。IDEA 支持设置模板变量可以让每个开发者自动带上自己的系统用户名或者统一使用固定的项目名称、版权声明不用每次新建文件都手动改非常省事。2. 最常用的设置方法File and Code Templates2.1 打开设置面板的三种方式IDEA 的设置入口有好几个用习惯了都差不多看个人顺手程度菜单栏File-SettingsWindows/Linux或IntelliJ IDEA-PreferencesmacOS快捷键Ctrl Alt SWindows/Linux或Cmd ,macOS快捷搜索连按两次Shift键输入File and Code Templates直接跳到设置页这三种方式殊途同归。我平时最快用的是连按两次 Shift 搜索因为不用展开菜单直接键入就能到。如果你用的是新版本 IDEA搜索面板的响应速度更快推荐试试。2.2 一步步设置文件头模板进入设置后按下面步骤操作在左侧找到Editor展开后选择File and Code Templates。切换到Includes标签页这里有个File Header选项。点击右侧的编辑区把默认内容替换成你自己想要的模板。举个最常用的模板例子/** * author 你的名字 * date ${DATE} ${TIME} * description xxx */注意这个模板作用于所有新创建的 Java 文件包括 Class、Interface、Enum 等。你只要在File Header里写好之后新建类时就会自动带到文件顶部。设置完成后点击Apply或者OK新建一个类验证一下。如果之前已经打开过项目IDEA 通常不需要重启但个别老版本可能不生效这个后文会专门讲排查方法。2.3 不同文件类型的模板覆盖范围IDEA 的File and Code Templates设置里除了Includes下的File Header还有Files标签页里面列了Class、Interface、Enum、Annotation Type、Record等文件类型。每个文件类型都可以单独指定模板默认情况下它们都会引用File Header作为公共头。举个例子如果你只想给Class加作者信息给Interface不加可以修改Files - Class的模板#if (${PACKAGE_NAME} ${PACKAGE_NAME} ! ) package ${PACKAGE_NAME}; #end /** * 类的说明 * * author 你的名字 * date ${DATE} */ public class ${NAME} { }这里#if是用来判断包名是否为空的 Velocity 模板语法IDEA 原生支持改完以后新建 Class 就会按这个模板走。需要注意的是File Header是“全局头”它会被Files里所有文件类型的模板引用。如果你在某个文件类型模板里没有写#parse(File Header.java)那全局头就不会自动出现。这也是一个常见的“为什么我设了不生效”的原因。3. 进阶玩法动态变量与模板组合3.1 IDEA内置模板变量设置作者信息最忌讳的是写死一个名字。比如你写了author 张三但后来这个项目是几个人在维护每次新建文件都手动改成自己的名字很麻烦。IDEA 提供了动态变量可以直接引用系统信息。最常用的几个变量变量含义示例输出${USER}当前系统用户名admin、zhangsan${DATE}当前日期2025/01/15${TIME}当前时间09:30:00${YEAR}当前年份2025${MONTH}当前月份01${MONTH_NAME}当前月份英文名January${DAY}当前日15${HOUR}当前小时09${MINUTE}当前分钟30${NAME}新建文件的类名UserController${PACKAGE_NAME}当前包名com.example.demo有了这些变量你可以让文件头在每次新建文件时自动带上创建者的系统用户名和当前时间完全不用手动改。我个人的模板是这样的/** * author ${USER} * date ${YEAR}-${MONTH}-${DAY} ${TIME} */这样新建文件后自动生成类似/** * author zhangsan * date 2025-01-15 14:23:05 */${USER}取的是操作系统当前登录用户。在 Windows 上通常是你电脑的用户名在 macOS 上通常是你的短用户名。如果你想让展示的名字更友好可以在模板里直接写你的中文名或英文昵称但这会让模板不支持多人共用看团队需求来定。3.2 自定义类注释与方法注释类文件的头部作者信息设置好了方法注释很多人也想统一。这里要区分一下类注释走的是File and Code Templates方法注释一般用Live Templates来实现因为方法注释需要在输入时动态生成模板代码的位置和参数是活的。IDEA 自带的 Live Templates 中输入/**回车会生成基础的 javadoc 注释但没有作者信息。如果你想给方法也加上作者可以通过Settings - Editor - Live Templates新建一个模板。比较常见的做法是定义一个缩写比如mc模板内容如下/** * 方法说明 * * author ${USER} * date ${YEAR}-${MONTH}-${DAY} ${TIME} * param $params$ * return $returns$ */然后在Edit variables里把params设置为groovyScript自动遍历参数列表把returns设置为methodReturnType()。这类方法已经有很多人分享过这里不展开太多但核心思路是一样的利用 IDEA 的模板变量和函数把作者信息、时间信息自动带入。方法注释要不要加作者不同团队有不同看法。有的团队认为方法注释加作者会导致文件膨胀只需要类注释注明作者即可。这个没有绝对对错建议按项目规范来。我个人习惯是类注释必须加作者方法注释只写业务说明不写作者因为方法经常被多人改写死作者反而容易误导。3.3 多作者协作场景下的模板写法如果你是自己单机开发模板里直接写死名字完全没问题。但在团队里不能所有人共用一个写死的名字。所以更合理的做法是模板使用${USER}动态变量自动取每个人的系统用户名。不用${USER}而是让每个人自己修改模板里的名字。把模板文件纳入团队代码脚手架通过项目级设置下发。比如公司要求统一格式为/** * author 员工姓名 * date 创建日期 */那就需要每个人在自己的 IDEA 里把员工姓名改成自己的名字。如果你是一个共享账号开发比如用测试机或远程开发环境那么${USER}可能都是同一个值这时候就要考虑在每个项目里单独设置了。IDEA 还支持项目级模板覆盖全局模板。在Settings - Editor - File and Code Templates里有Project级别和Default级别的切换。Default是针对全局所有项目的Project只对当前打开的项目生效。团队协作时可以把项目特有的模板配在Project级别这样不同项目可以有不同风格互不干扰。4. 作者信息与版本控制理清IDEA和Git的关系4.1 IDEA作者信息和Git提交者的区别很多人混淆一个概念我明明设置了 IDEA 作者信息为什么 Git 提交记录里的提交人还是别人或者反过来改了半天 IDEA 的作者提交记录没变化。这两个真不是一回事。IDEA 文件头里的author是代码里的注释属于文件内容的一部分。它只影响你新建代码文件时自动出现在文件顶部的文字跟 Git 提交记录没有任何关系。Git 提交记录里的作者是由全局或仓库级 Git 配置决定的也就是user.name和user.email。每次git commit时Git 会读取这个配置把它写入提交对象中。所以你要改的是 Git 配置不是 IDEA 模板。4.2 如何正确设置Git的user.name和user.email在终端里可以使用# 查看当前仓库的用户名和邮箱 git config user.name git config user.email # 设置全局所有仓库生效 git config --global user.name zhangsan git config --global user.email zhangsanexample.com # 设置当前仓库只影响当前项目 git config user.name zhangsan git config user.email zhangsanexample.comIDEA 里也可以在Settings - Version Control - Git里直接配置。右侧User.name和User.email填上对应值即可。这里配置的值相当于仓库级 Git 配置优先级高于全局配置。需要说明的是IDEA 的 Git 配置只对 IDEA 自身的 Git 操作生效。如果你在外面用命令行提交走的是终端里的 Git 配置。所以最稳妥的做法是用命令行把全局配置设置好这样无论 IDEA 还是终端提交记录都是统一的。4.3 提交代码时作者显示不对怎么办常见情况是Git 提交记录里显示的是Administrator或者unknown这是因为他没有设置过user.name和user.emailGit 自动取了系统用户名。解决办法很简单按上面的命令设置一次全局用户名和邮箱即可。还有一种情况你换了电脑或者换了公司邮箱但旧项目还是显示旧作者。因为 Git 记录一旦提交就不可变只能通过git rebase或git filter-branch来修改历史这个操作比较有风险一般不建议主动使用。如果你希望“从此以后”都用一个指定的作者比如公司要求的专用账号那就设置git config --global user.name zhangsan-fe git config --global user.email zhangsancorp.com之后再提交就是新作者。已经提交的记录不要强行改除非有明确需求。5. 常见问题排查与实用技巧5.1 常见问题速查表问题可能原因解决办法新建文件没有作者信息File Header模板被覆盖或未保存检查 File and Code Templates 的 Includes 里 File Header 内容保存后新建文件验证作者信息显示了但格式乱模板中有特殊字符或语法错误删除多余字符用简单模板测试${USER} 显示成系统英文名系统用户名就是这个值模板中可直接写中文名替代或用 ${USER} 的别名变量设置了但不生效IDEA缓存或模板类型不匹配File - Invalidate Caches / Restart清理缓存重启新建Enum没有作者Files标签页Enum模板未引用File Header在Enum模板中添加#parse(File Header.java)加了 date 但日期是创建当天的变量本身取的就是创建时间这是正常的模板变量不随修改更新Git提交者不是IDEA设置的名字改的是文件头模板不是Git配置到 Settings - Version Control - Git 或命令行配置 user.name 和 user.email这些是我实际使用中遇到过的高频问题。尤其是“设置了但不生效”很多时候不是设置错了而是改的是Files标签页下的某个具体类型模板但那个模板里没有引用File Header.java结果新的作者信息没有拼接进去。5.2 让新文件默认带上日期的细节${DATE}变量的输出格式默认跟系统区域有关。中文系统下通常输出2025/01/15英文系统下可能是01/15/25。如果你想统一格式建议直接组合年份、月份、日期变量/** * author ${USER} * date ${YEAR}-${MONTH}-${DAY} */这样输出永远是四位年份、两位月份、两位天例如2025-01-15不会因为系统语言环境不同而变化。如果还需要精确到秒再加${TIME}。这是我在团队统一模板时总结出来的一个小技巧别看差别不大跨平台协作时非常有用。5.3 团队统一模板的落地经验团队协作时如果每个人都手动改一遍模板难免有人改错、有人漏改。我的做法是先写好一份标准模板格式、字段全部确定。通过 IDEA 的File - Manage IDE Settings - Export Settings导出配置文件分发给团队。或者在项目根目录放一个脚手架模板用项目级 File Header 覆盖全局配置。导出设置时需要注意只导出需要的部分避免把个人快捷键、主题等杂项也带到团队里。更轻量的方式是直接贴一段模板内容让大家复制改动量最小。另外如果你用的是公司统一的代码规范插件或检查规则可以在规范文档里写明文件头格式再把 IDEA 模板示例贴出来。这样即使有人换了电脑、换了 IDEA也能照着配置。6. 我踩过的几个坑和最终建议6.1 模板不生效的三个原因我最早设置作者信息的时候明明改了 File Header新建类却没有反应。后来折腾半天才发现三个坑第一我改的是Files - Class模板里的内容而不是Includes - File Header。Class 模板默认生成时确实会引用 File Header但如果你在 Class 模板里写的是静态内容那后续改 File Header 也不会影响已经生成的文件。第二改完模板后没有重新建文件而是去改旧文件。模板只对新建文件生效对已存在的旧文件没有任何作用。如果你想给旧文件统一补上作者信息只能手动改或者用全局替换。第三IDEA 老版本存在缓存问题。修改模板后如果一直不生效可以试一下File - Invalidate Caches / Restart等重启后重新测试。记住一个关键点模板文件的作用时机是“新建文件时”不是“打开文件时”。所以设置完成之后一定要新建一个测试文件来验证。6.2 我的推荐配置如果让我给一个相对通用、不太会出错的配置大概是这样的在File and Code Templates - Includes - File Header里写/** * author ${USER} * date ${YEAR}-${MONTH}-${DAY} * description 请填写业务说明 */这样每一个新文件都会自动生成一个带作者和日期的头部注释。业务说明那行在创建文件后手动补充逼着自己把类的职责写清楚。这个方法对上对下都友好老大看到代码有说明接手的人也不会一头雾水。如果你不想每次都用系统用户名想显示更正式的名字可以把${USER}直接改成你的名字首字母或者常用昵称。比如/** * author lisi * date ${YEAR}-${MONTH}-${DAY} */我个人更推荐写成拼音或英文名避免 IDEA 编码问题导致中文乱码。但如果你用新版 IDEA或者统一了文件编码为 UTF-8中文注释一般没问题。6.3 最后再分享一个小技巧设置好作者信息后我习惯把File Header里加一个版权声明只需要一行/** * author ${USER} * date ${YEAR}-${MONTH}-${DAY} * copyright 2025 某公司 */这样可以避免项目交付时被追问代码来源也能防止内部代码被外部人员随意复制时没有任何归属标识。虽然版权声明不只是写一行字那么简单但至少在文件层面留了个记号。另外如果你在 IDEA 里用到了 AI 插件有些插件也会读取文件头来做代码上下文理解你设置好作者和描述之后插件生成的注释会更能贴合你的项目风格。顺手做一下真不亏。