WebStorm 2025.2 Help

创建实时模板

以下示例过程演示了如何为带有当前日期、用户名以及两个展开为输入字段的用户自定义变量的 TODO 注释创建模板。

  1. Ctrl+Alt+S 打开设置,然后选择 编辑器 | 实时模板

  2. 选择您希望创建新实时模板的模板组(例如, 其他)。

    如果未选择模板组,则实时模板将添加到 用户 组中。

  3. 单击 添加按钮 ,然后选择 实时模板

  4. 指定模板可用的上下文。 默认情况下未指定上下文,WebStorm 会在对话框底部显示消息。

    无可用上下文消息

    在消息下方单击 定义 ,然后勾选适用上下文旁的复选框。

    创建实时模板:指定适用的上下文
  5. 缩写 字段中,指定用于展开模板的字符。 例如: todo。 您还可以定义应用新添加模板的语言。

  6. (可选)在 描述 字段中,为模板添加描述以供将来参考。

    例如: 插入包含当前日期、用户,以及两个用于输入 TODO 建议和相关项目名称的输入字段的 TODO 注释。

  7. 模板文本 字段中,使用 变量 指定模板正文。 例如:

    //TODO added on $DATE$ by $USER$: consider $todo$ for project $project$
  8. 单击 编辑变量 ,使用 函数 定义变量:

    名称

    表达式

    默认值

    已定义时跳过

    DATE

    date()

    USER

    user()

    您可以为表达式评估失败时设置默认值,尽管这些特定函数应始终返回有效值。 您还可以禁用变量的 如已定义则跳过 选项,以高亮显示展开的值并允许用户在必要时进行修改。

  9. 应用所有更改。

  10. 在编辑器中键入 todo 并按下 Tab

从代码片段创建新模板

  1. 在编辑器中选择要用于创建实时模板的文本片段。

  2. 从主菜单中选择 代码 | 另存为实时模板...。 实时模板列表将打开。 在此列表中,新创建的模板已添加到 用户 组中。

  3. 为模板指定缩写、可选描述(用于标识模板用途)并修改模板正文。 如果模板已定义 变量 ,请单击 编辑变量 以进行配置。

  4. 单击 确定 应用更改。

复制现有模板

如果希望在多个组中复用同一模板,或希望基于已有模板创建新模板,则可以复制现有模板。

  1. 编辑器 | 实时模板 页的 设置 对话框(Ctrl+Alt+S )中,选择要复制的模板。

  2. 在工具栏中单击 复制 复制按钮。 将在与原始模板相同的组中添加并选中新模板项。

  3. 为模板指定新缩写、可选描述(用于标识模板用途),并在必要时修改模板正文。 如果模板已定义 变量 ,请单击 编辑变量 进行配置。

  4. 单击 确定 应用更改。

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