HTML文件头部注释需IDE模板（创建时）、File Watcher或插件（修改时）及Git Hook（提交前）三者协同：IDE配置${USER}/${DATE}/${TIME}变量，VSCode用koroFileHeader设autoAdd与updateOnSave，WebStorm用File Watcher调脚本，Git Hook校验日期并格式化。
能统一生成 HTML 文件头部注释的工具链已经很成熟，关键不是“能不能”，而是选对触发时机和模板控制点——文件创建时用 IDE 模板，文件修改时靠 File Watcher 或 Git Hook，两者必须配合，否则作者、时间、描述三项极易脱节。
IntelliJ IDEA / WebStorm 创建 HTML 时自动插入头部注释
IDEA 和 WebStorm 都支持在新建 HTML 文件时填充预设模板，但默认不带作者和动态时间变量，需手动配置：
- 进入
Settings → Editor → File and Code Templates → Files，选中HTML File - 将默认内容替换为类似以下结构（注意保留
${USER}、${DATE}、${TIME}等内置变量）：<!DOCTYPE html> <html lang="zh-CN"> <head> <meta charset="UTF-8"> <title>${NAME}</title> </head> <body> <p></body> </html> <!-- @Author: ${USER} @Date: ${DATE} @Time: ${TIME} @Description: ${DESCRIPTION} --> -
${DESCRIPTION}不是原生变量，需在模板编辑器右下角点击Define Macros...添加自定义宏，例如返回空字符串或提示输入 - 该方式只在 新建文件时生效，后续保存或修改不会更新注释
WebStorm 中修改文件时自动更新作者与时间
仅靠模板无法解决“最后一次修改人/时间”问题，WebStorm 的 File Watcher 是更可靠的方案：
- 需搭配外部脚本（如 Node.js 或 Python），监听 HTML 文件保存事件，解析并重写头部注释块
- 推荐使用
jsdoc风格标记，例如识别<!-- @Author:行，用当前用户名和new Date().toISOString().split('T')[0]替换 - 在
Settings → Tools → File Watchers中导入或新建 watcher，设置Program为脚本路径，Arguments传入$FilePath$ - 勾选
Auto-save edited files before run和Trigger on external changes，确保编辑器内保存和命令行修改都触发 - 注意：脚本需有读写权限，且不能阻塞主线程，否则保存会卡顿
VS Code 用户如何实现类似效果
VS Code 没有原生 File Watcher，但可通过插件组合达成近似效果：
立即学习“前端免费学习笔记（深入）”；
- 安装
koroFileHeader插件，它支持 HTML，并可配置fileheader.cursorMode控制光标位置 - 在
settings.json中设置："fileheader.customMade": { "Author": "your-name", "Date": "Do not edit", "LastEditors": "your-name", "LastEditTime": "Do not edit" }, - 关键点：启用
fileheader.configObj.autoAdd并设为true，新文件自动插入；同时开启fileheader.configObj.updateOnSave，保存时刷新LastEditors和LastEditTime - 该插件会扫描已有注释块，只更新匹配字段，不破坏原有结构，但要求注释格式严格符合其识别规则（如必须含
@Author）
Git 提交前强制校验与格式化
本地工具再完善，也防不住绕过编辑器直接改文件。Git Hook 是最后一道防线：
- 在
.git/hooks/pre-commit中添加脚本，用grep -q "@Date.*${TODAY}" *.html检查日期是否为当天 - 调用
prettier --write --parser html统一注释空格（如<!-- foo -->→<!-- foo -->，注意前后空格） - 若检测失败，输出错误信息并
exit 1中断提交，例如：Error: header comment in index.html has stale @Date - 团队需统一部署该 hook，建议用
husky管理，避免手动拷贝遗漏
真正难的不是生成注释，而是让“作者”“最后修改时间”“描述”三项始终真实可信——这要求每个环节都明确职责：IDE 负责初始模板，编辑器插件或 File Watcher 负责增量更新，Git Hook 负责兜底校验。少一个环节，注释就会慢慢变成摆设。
