PyCharm 2025.2 Help

创建实时模板

下面的示例过程说明如何创建一个带有当前日期和用户名的 TODO 注释模板。

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

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

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

  3. 点击 添加按钮 并选择 实时模板

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

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

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

    添加一个待办事项模板
  6. (可选)在 描述 字段中,描述模板以供将来参考。

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

  7. 模板文本 字段中,请指定带有 变量的模板主体。 例如:

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

    名称

    表达式

    默认值

    如果已定义则跳过

    日期

    日期()

    用户

    用户()

    当表达式无法计算时,您可以设置一个默认值,尽管这些特定函数应始终返回有效值。 您还可以禁用 如果已定义则跳过 选项,以突出显示展开的值,并在必要时让用户修改它。

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

  10. 在编辑器中,输入 todo 并按 Tab

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

    # TODO 09/02/2021 jetbrains:

    使用模板

从代码片段创建新模板

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

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

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

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

复制现有模板

如果您想在多个组中重用相同的模板,或者想基于另一个模板创建一个新模板,您可以复制一个现有的模板。

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

  2. 请点击 重复 重复按钮 工具栏。 新增的模板项将添加到与原始项相同的组中,并且会被选中。

  3. 请为模板指定一个新的缩写,并提供一个可选的描述(以识别模板的用途),并在必要时修改模板正文。 如果模板定义了 变量 ,请点击 编辑变量 来进行配置。

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

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