文件模板变量
文件模板可以包含变量,这些变量在应用模板时被它们的值替换。变量是以美元符号$
开头后跟变量名的字符串。变量名可以选择用花括号括起来。例如:$MyVariable
和${MyVariable}
是同一变量的不同表示法。
预定义的模板变量
以下预定义变量可用于文件模板:
多变的 | 描述 |
---|---|
| 当前系统日期 |
| 每月的当前日期 |
| 美元符号 |
| 新 PHP 文件的名称 |
| 当前时间 |
| 当前分钟 |
| 当前秒 |
| 这个月 |
| 当月全名(一月、二月等) |
| 当前月份名称的前三个字母(Jan、Feb 等) |
| 新实体的名称(文件、%class%、接口等) |
| 类或字段命名空间的完全限定名称(不带前导斜杠) |
| IDE 的名称(例如,PhpStorm) |
| 当前项目名称 |
| 当前系统时间 |
| 当前用户的登录名 |
| 今年 |
PhpStorm 为PHP 包含模板提供了一组附加变量,用于定义可重用的代码片段,例如文件头和PHPDoc 注释。
在PHP 包含模板中可以使用以下附加的预定义变量:
多变的 | 描述 |
---|---|
| 完成变量编辑后的插入符号位置。仅在文件创建期间生成和插入 PHPDoc 注释时应用。 |
| 定义为其生成 PHPDoc 注释的字段或方法的类的名称 |
| 将为其生成 PHPDoc 注释的类、字段或函数(方法)的名称 |
| 类或字段命名空间的完全限定名称(不带前导斜杠) |
| 参数的文档注释。评估为一组 |
|
|
| 异常的文档注释。评估为一组 |
| 生成 PHPDoc 注释的函数(方法)的返回值。如果无法通过函数(方法)的静态分析检测到返回类型,则计算为 |
自定义模板变量
除了预定义的模板变量外,还可以指定自定义变量。#set
如有必要,您可以使用指令在模板中定义自定义变量的值。在使用相应变量之前编写指令。
例如,如果您想使用您的全名而不是通过预定义变量定义的登录名${USER}
,请在您的自定义变量之前添加以下构造:
如果模板中没有定义变量的值,PhpStorm 会在应用模板时要求您指定它。