PhpStorm 新建 PHP 文件时自动插入作者、日期等信息需在 File and Code Templates 中配置 $USER$ 和 $DATE$ 变量,变量名大小写敏感且不可手写为 $author$;Git 用户名需通过 VM 参数 -Dgit.user.name=$(git config --get user.name) 注入并用 $git.user.name$ 调用。

文件模板里加 $USER$ 和 $DATE$ 变量就行
PhpStorm 新建 PHP 文件时自动插入作者、日期等信息,靠的是 File and Code Templates 里的文件模板,不是 Live Templates 或注释模板。关键点在于:变量必须用 $USER$(系统用户名)、$DATE$(格式固定为 yyyy-MM-dd)、$TIME$(HH:mm),不能手写成 $author$ 或 $nowTime$——后者只在 Live Templates 里生效,放错地方就完全不触发。
实操建议:
- 打开
Settings > Editor > File and Code Templates - 选中左侧
Files栏下的PHP File - 在右侧编辑框顶部插入标准 PHPDoc 头,例如:
/** * <code>@package</code> ${NAMESPACE} * <code>@author</code> $USER$ * <code>@created</code> $DATE$ $TIME$ */ - 注意:变量名大小写敏感,
$user$或$username$都不会被识别
想填 Git 用户名而不是系统用户名?得改 IDE 启动参数
$USER$ 默认取操作系统登录名,和 Git 配置的 user.name 没关系。如果团队要求版权信息必须和 Git 提交作者一致(比如统一显示 “Zhang San”),就不能依赖这个变量。
可行路径只有一条:让 PhpStorm 启动时读取 Git 配置。方法是修改 IDE 的 VM options:
立即学习“PHP免费学习笔记(深入)”;
- 关闭 PhpStorm
- 找到配置文件:
Help > Edit Custom VM Options...(首次会提示创建) - 添加一行:
-Dgit.user.name=$(git config --get user.name) - 重启后,在模板里用
$git.user.name$即可(注意点号要换成下划线,IDE 内部变量命名规则) - ⚠️ 缺陷:该值只在启动时读取一次,Git 配置改了得重启 IDE 才生效
Live Templates 也能补作者,但只适用于手敲注释场景
如果你习惯写函数前手动敲 /** 再按 Tab 补全完整 PHPDoc,那就该用 Live Templates,不是文件模板。
这里的关键差异:
- Live Templates 中可用
$AUTHOR$变量(需在Edit variables里手动绑定到gitUserName()或userName()函数) - 模板缩写建议设为
phpdoc,输入后按Tab触发,比等自动弹窗更可控 - 别把
phpdoc模板作用域设成 “Everywhere”,否则在字符串里敲/都可能误触发 - 如果用了 Laravel 或 Symfony,建议额外加
@return static或@throws占位符,避免每次都要删
团队同步模板要注意 .jar 冲突和路径硬编码
导出模板为 .jar 分发给同事时,容易踩两个坑:
- 模板里若写了绝对路径(比如
@copyright 2024 /home/xxx/company),别人导入后会直接显示你本地路径——所有路径类文字必须用变量或留空 - 如果团队有人用 Windows、有人用 macOS,
$USER$在 Windows 上可能返回DESKTOP-XXXX\username,建议统一用userName()函数替代(在 Live Templates 变量设置里选) - PHPDoc 里
@license如果填了具体 URL,检查是否公司内网可访问;外网链接失效会导致部分文档生成工具报错
真正难的不是填上作者,而是让所有人填的格式、变量来源、更新机制都一致——文件模板管新建,Live Templates 管手补,Git 用户名要靠 VM 参数撬动,三者混用时最容易漏掉其中一环。



















