PhpStorm 2021.3 Help

文件模板

文件模板是您创建的新文件的默认内容的规范。根据您正在创建的文件类型,模板会提供该类型的所有文件中预期的初始代码和格式(根据行业或语言标准、您的公司政策或其他原因)。

PhpStorm 为您创建新文件时建议的所有受支持文件类型提供预定义模板。

管理和配置文件模板

  • Ctrl+Alt+S打开 IDE 设置并选择Editor | 文件和代码模板

有关详细信息,请参阅文件和代码模板

默认情况下,模板列表仅包含 PhpStorm 提供的预定义模板。其中一些是内部的,这意味着它们不能被删除或重命名。PhpStorm 以粗体显示内部模板的名称。您修改的模板的名称以及您手动创建的自定义模板以蓝色显示。

以下过程描述了如何创建文件模板。类似的过程可用于创建包含模板

创建一个新的文件模板

  1. Ctrl+Alt+S打开 IDE 设置并选择Editor | 文件和代码模板

  2. 文件选项卡上,单击创建模板按钮并指定模板的名称、文件扩展名和正文。

  3. 应用更改并关闭对话框。

复制现有文件模板

  1. Ctrl+Alt+S打开 IDE 设置并选择Editor | 文件和代码模板

  2. 文件选项卡上,单击复制模板按钮并根据需要修改模板的名称、文件扩展名和正文。

  3. 应用更改并关闭对话框。

将文件另存为模板

  1. 在编辑器中打开一个文件。

  2. 从主菜单中,选择文件 | 将文件另存为模板

  3. 在“将文件另存为模板”对话框中,指定新模板名称并根据需要编辑正文。

  4. 应用更改并关闭对话框。

句法

文件模板使用Velocity 模板语言(VTL),它包括以下结构:

  • 按原样呈现的纯文本。

  • 被其值替换的变量。例如,${NAME}在添加文件时插入用户提供的名称。

  • 各种指令,包括#parse#set#if等。

开始输入$#查看可用变量和指令的完成建议。

有关详细信息,请参阅VTL 参考指南

以下示例显示了在 PhpStorm 中创建 PHP 类的默认模板:

<?php #parse("PHP File Header.php") #if (${NAMESPACE}) 命名空间 ${NAMESPACE}; #end class ${NAME} { }

该模板组织如下:

  • #parse指令用于插入PHP File Header.php模板的内容。

  • #if指令用于检查命名空间是否为空。如果不是,则将其名称namespace作为值添加到语句中${NAMESPACE}

  • 然后模板声明一个类,其名称作为${NAME}值(新文件的名称)传递。

当您基于模板创建一个新的 PHP 类时,会生成一个内容类似于以下内容的文件:

<?php /** * 由 PhpStorm 创建。* 用户:jetbrains * 日期:03/07/2018 * 时间:16:16 */ namespace My\Name; 我的班级 { }
最后修改:2021 年 11 月 19 日