文件模板

文件模板是新建文件的默认内容规范，您可以通过文件 | 新建菜单或项目树中的新建上下文菜单部分创建新文件时使用。

根据所创建文件的类型，模板会提供该类型文件应具备的初始代码和格式（根据行业或语言标准、公司策略或其他原因）。

WebStorm 为所有受支持的文件类型提供预定义模板，在新建文件时自动建议使用。

管理和配置文件模板

按下 Ctrl+Alt+S 打开设置，然后选择编辑器 | 文件与代码模板。

如需了解更多信息，请参阅文件与代码模板。

默认情况下，模板列表仅包含 WebStorm 提供的预定义模板。其中某些模板是内部模板，无法删除或重命名。 WebStorm 会将内部模板的名称以粗体显示。您修改过的模板及手动创建的自定义模板名称会以蓝色显示。

以下过程介绍如何创建文件模板。您可以使用类似的过程来创建 include 模板。

创建新的文件模板

按下 Ctrl+Alt+S 打开设置，然后选择编辑器 | 文件与代码模板。
使用方案列表选择文件模板适用的作用域：
- 默认：在 IDE 级别创建的文件模板。这些模板在当前 IDE 实例中打开的所有项目中均可用。可将其用作您的个人模板，无论具体项目如何都可以使用。 WebStorm 会将全局模板存储在 IDE 配置目录中的 fileTemplates 。
- 项目：特定于当前项目的文件模板。这些模板对参与此项目的所有人员均可用。 WebStorm 会将其存储在项目文件夹下的 .idea/fileTemplates 中。
在文件选项卡中，点击并指定模板名称、文件扩展名、结果文件名称以及模板正文。
应用更改并关闭对话框。

复制现有文件模板

按下 Ctrl+Alt+S 打开设置，然后选择编辑器 | 文件与代码模板。
在文件选项卡中，点击，根据需要修改名称、文件扩展名和模板正文。
应用更改并关闭对话框。

将文件保存为模板

在编辑器中打开一个文件。
在主菜单中，转到文件 | 将文件另存为模板。
在将文件另存为模板对话框中，指定新模板名称、扩展名，并根据需要编辑正文。有关文件模板中使用语法的详细信息，请参阅语法
- 文件名：如有需要，为根据此模板创建的文件指定一个名称。默认情况下，在添加文件时，WebStorm 会提示用户输入名称。您可以硬编码一个特定名称以跳过输入提示，或使用可用变量组合模板。例如，下面说明了如何使用指定名称，但将其置于创建文件时选择的上一级目录中： ../${NAME}
- 按照样式重新设置格式(R) ：根据该模板生成的内容将按为此文件类型定义的代码样式重新格式化。
- 启用实时模板(L) ：在文件模板中插入实时模板。使用 Velocity 转义语法在文件模板中插入实时模板变量，例如： #[[ $MY_VARIABLE$ $END$ ]]#
应用更改并关闭对话框。

语法

文件模板使用 Velocity 模板语言（VTL），包含以下结构：

纯文本按原样呈现。
变量，将被其值替换。例如， ${NAME} 会插入用户添加文件时提供的名称。
各种指令，包括 #parse、 #set、 #if 等。

开始输入 $ 或 # 以使用代码补全提供的变量和指令建议。

如需了解更多信息，请参阅 VTL 参考指南。

以下示例显示了在 WebStorm 中创建 JavaScript 类的默认模板：

                /**
                 * Created by ${USER} on ${DATE}
                 */
            
  

在此模板中， ${USER} 和 ${DATE} 是模板变量。

当您创建新的 JavaScript 文件时，此模板会生成如下所示内容的文件：

                /**
                 * Created by John.Smith on 6/7/11
                 */
            
  

以下示例展示了在 WebStorm 中创建 Gherkin feature 文件的默认模板：

            # Created by ${USER} at ${DATE}

            Feature: #Enter feature name here
            # Enter feature description here

            Scenario: # Enter scenario name here
            # Enter steps here

在此模板中， ${USER} 和 ${DATE} 是模板变量。当您创建新的 Gherkin 文件时，此模板会生成如下所示内容的 feature 文件：

                # Created by jetbrains at 25.06.2018

                Feature: #Enter feature name here
                # Enter feature description here

                Scenario: # Enter scenario name here
                # Enter steps here

最后修改日期： 2025年 9月 26日