WebStorm 2025.2 Help

文件模板变量

文件模板 可以包含变量，应用模板时这些变量会被其值替换。 变量是以美元符号 $ 开头，后跟变量名称的字符串。 变量名称可以选择性地用大括号括起来。 例如： $MyVariable 和 ${MyVariable} 是同一变量的不同表示方式。

模板正文和文件名中都可使用预定义变量和自定义变量。 例如，若在模板的 文件名 字段中键入 MyFile_${MONTH_NAME_FULL} ，并在四月创建文件，则生成的文件名为 MyFile_April。 此处， ${MONTH_NAME_FULL} 是一个 预定义 变量。 如果您改用 自定义 变量，则在基于该模板创建文件时，WebStorm 将提示您输入该变量的值。

预定义模板变量

以下预定义变量可在文件模板中使用：

变量

描述

${DATE}

当前系统日期

${DAY}

当前日期中的日

${DIR_PATH}

新文件所在目录的路径（相对于项目根目录）

${DS}

美元符号 $。 该变量用于转义美元符号字符，以防其被视为模板变量的前缀。

${HOUR}

当前小时

${MINUTE}

当前分钟

${SECOND}

当前秒

${MONTH}

当前月份

${MONTH_NAME_FULL}

当前月份的全名（如 January、February 等）

${MONTH_NAME_SHORT}

当前月份名称的前三个字母（如 Jan、Feb 等）

${NAME}

新实体的名称（文件、类、接口等）

${PRODUCT_NAME}

IDE 的名称（例如，WebStorm）

${PROJECT_NAME}

当前项目名称

${TIME}

当前系统时间

${USER}

当前用户的登录名

${YEAR}

当前年份

变量方法

由于 WebStorm 使用 Velocity 作为文件模板的模板引擎，因此模板中的变量可以使用 Java String 方法。 例如，以下用法是可行的：

  • ${NAME.toUpperCase()} ：将新实体（文件）的名称转换为大写字母。

  • ${PROJECT_NAME.length()} ：打印项目名称的长度。

  • ${PRODUCT_NAME.substring(0,5)} ：打印所用 IDE 名称的前五个字符。

自定义模板变量

除了预定义模板变量外，您还可以指定自定义变量。 如有需要，您可以在模板中使用 #set 指令直接定义自定义变量的值。 请在使用变量之前编写该指令。

例如，如果您希望使用全名替代通过预定义变量 ${USER} 定义的登录名，请在自定义变量前添加以下结构：

#set( $MyName = "John Smith" ) Created by: $MyName
自定义文件模板变量

在用于创建类的模板中，您可以不为自定义变量指定值。 应用模板时，WebStorm 将要求您指定这些值。

以下示例展示了一个用于创建 TypeScript 类的自定义模板。 该模板包含两个自定义变量： ${MyName} 和 ${class_name}。

用于创建 TypeScript 类的自定义模板

使用此模板创建类时，WebStorm 会显示一个对话框，要求您为 ${MyName} 和 ${class_name} 指定值。

通过自定义模板创建 TypeScript 类：指定自定义变量的值
最后修改日期： 2025年 9月 26日
文件模板模板中的可重用内容