PyCharm 2025.3 Help

创建动态模板

以下示例过程演示如何创建一个用于包含当前日期和用户名的 TODO 注释的模板。

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

  2. 选择要在其中创建新动态模板的模板组(例如, 其他)。

    如果未选择模板组,动态模板将添加到 用户 组。

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

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

    点击消息下方的 定义 ,然后选中适用上下文旁边的复选框。

  5. 缩写 字段中,指定用于展开模板的字符。 例如: todo。 您还可以定义要应用新添加模板的语言。

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

    例如: Insert TODO comment with the current date and username

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

    # TODO $DATE$ $USER$: $END$
  8. 点击 编辑变量 ,使用 函数 定义变量:

    名称

    表达式

    默认值

    如果已定义则跳过

    DATE

    date()

    USER

    user()

    您可以在表达式无法求值时设置默认值,不过这些特定函数应始终返回有效值。 您还可以为变量禁用 如果已定义则跳过 选项,以突出显示展开后的值,并在必要时允许用户修改。

    编辑模板变量
  9. 应用您的所有更改。

  10. 在编辑器中,键入 todo ,然后按 Tab

    根据当前系统日期和用户名,模板应展开为类似以下内容:

    # TODO 09/02/2021 jetbrains:

    使用该模板

从代码片段创建新模板

  1. 在编辑器中,选择要从中创建动态模板的文本片段。

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

  3. 为该模板指定缩写、可选的描述(用于说明模板用途),并修改模板主体。 如果模板定义了 变量 ,请点击 编辑变量 进行配置。

  4. 点击 确定 以应用更改。

复制现有模板

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

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

  2. 在工具栏上,点击 复制 “复制”按钮。 会在与原始模板相同的组中添加一个新的模板项,并将其选中。

  3. 为该模板指定新的缩写、可选的描述(用于说明模板用途),并在必要时修改模板主体。 如果模板定义了 变量 ,请点击 编辑变量 进行配置。

  4. 点击 确定 以应用更改。

最后修改日期: 2025年 12月 2日