文件模板
文件模板是新建文件的默认内容规范,您可以使用 菜单或项目树上下文菜单中的 新建 部分来创建这些文件。
根据您正在创建的文件类型,模板提供该类文件中的初始代码和格式(按照行业或语言标准、您的公司政策或其他原因)。
PhpStorm 提供了所有受支持文件类型的预定义模板,建议您在创建新文件时使用。
管理和配置文件模板
按 Ctrl+Alt+S 打开设置,然后选择 。
有关更多信息,请参见 文件和代码模板。
默认情况下,模板列表中仅包含 PhpStorm 提供的预定义模板。 其中一些是内部的,这意味着它们不能被删除或重命名。 PhpStorm 以加粗显示内部模板的名称。 您修改的模板名称以及您手动创建的自定义模板以蓝色显示。
以下过程描述了如何创建文件模板。 可以使用类似的程序来创建 include templates。
创建新文件模板
按 Ctrl+Alt+S 打开设置,然后选择 。
使用 方案 列表,选择文件模板应用的范围:
默认 :在 IDE 级别创建的文件模板。 这些模板在使用当前 IDE 实例打开的所有项目中都可以使用。 请将它们用作您个人喜欢的模板,而不论具体项目。 PhpStorm 将全局模板存储在 IDE 配置目录 下 文件模板 。
项目 :当前项目专用的文件模板。 这些模板适用于参与此项目的所有人员。 PhpStorm 将它们存储在 .idea/fileTemplates 下的项目文件夹中。
在 文件 选项卡上,点击
并指定模板名称、文件扩展名、生成文件的名称和模板的主体。
应用更改并关闭对话框。
复制现有文件模板
按 Ctrl+Alt+S 打开设置,然后选择 。
在 文件 选项卡上,点击
并根据需要修改模板的名称、文件扩展名和主体。
应用更改并关闭对话框。
将文件保存为模板
在编辑器中打开文件。
在主菜单中,进入 .
在 将文件另存为模板 对话框中,指定新模板名称和扩展名,并在必要时编辑主体。 有关文件模板中使用的语法的更多信息,请参见 语法
文件名 :如果需要,请为从此模板创建的文件指定一个名称。 默认情况下,PhpStorm 会提示用户在添加文件时输入名称。 您可以硬编码一个特定名称以完全避免提示,或从可用变量中编写模板。 例如,您可以这样使用指定的名称,但将其放置在文件创建时选择的目录上一级:
../${NAME}按照样式重新设置格式(R) :根据为此文件类型定义的 code style重新格式化基于此模板生成的内容。
启用实时模板(L) :在文件模板中插入 live templates。 在文件模板中使用 Velocity 转义语法包含 实时模板 variables ,例如:
#[[ $MY_VARIABLE$ $END$ ]]#
应用更改并关闭对话框。
语法
文件模板使用 Velocity Template Language (VTL),其中包括以下结构:
开始键入 $ 或 # ,以引用 补全建议的可用变量和指令。
如需更多信息,请参阅 VTL 参考指南。
以下示例显示了在 PhpStorm 中创建 PHP 类的默认模板:
此模板的组织方式如下:
#parse指令用于插入PHP File Header.php模板的内容。#if指令用于检查命名空间是否为空。 如果不为空,其名称将作为${NAMESPACE}值添加到namespace语句中。然后模板声明一个类,其名称作为
${NAME}值(新文件的名称)传递。
当您基于模板创建新的 PHP 类时,将生成一个内容类似于以下内容的文件: