phpstorm怎么配置PHPDoc自动填充作者信息(版权管理)

风强酱_7008

风强酱_7008

2026-04-23

939人浏览

原创

phpstorm 新建 php 文件时自动插入作者、日期等信息需在 file and code templates 中配置 $user$ 和 $date$ 变量,变量名大小写敏感且不可手写为 $author$;git 用户名需通过 vm 参数 -dgit.user.name=$(git config --get user.name) 注入并用 $git.user.name$ 调用。

phpstorm怎么配置phpdoc自动填充作者信息(版权管理)

文件模板里加 $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:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • 关闭 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 参数撬动,三者混用时最容易漏掉其中一环。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php phpstorm

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11144

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6461

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2155

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4088

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4814

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3771

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5417

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4242

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12142

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习