文件模板
最后修改时间:2023 年 11 月 28 日配置:设置| 编辑| 文件和代码模板CtrlAlt0S
文件模板是您创建的新文件的默认内容的规范。根据您要创建的文件类型,模板提供该类型的所有文件中预期的初始代码和格式(根据行业或语言标准、您的公司政策或其他原因)。
PyCharm 为您创建新文件时建议的所有支持的文件类型提供预定义模板。建议的文件类型集取决于模块和配置,以及项目工具窗口中当前位置的属性。例如,PyCharm 不会建议在 Python 源或测试目录之外创建 Python 文件。
管理和配置文件模板
按打开 IDE 设置,然后选择编辑器 | 文件和代码模板。CtrlAlt0S
提示
如果有多个项目,设置将应用于主项目,即项目树列表中的第一个项目。
有关更多信息,请参阅文件和代码模板。
默认情况下,模板列表仅包含 PyCharm 提供的预定义模板。其中一些是内部的,这意味着它们无法删除或重命名。PyCharm 以粗体显示内部模板的名称。您修改的模板以及您手动创建的自定义模板的名称显示为蓝色。
以下过程描述了如何创建文件模板。类似的过程可用于创建包含模板。
创建新的文件模板
按打开 IDE 设置,然后选择编辑器 | 文件和代码模板。CtrlAlt0S
使用方案列表,选择文件模板应用的范围:
默认:为整个应用程序配置文件模板。这些模板在您使用当前 IDE 实例打开的所有项目中都可用。无论具体项目如何,都可以将它们用作您喜欢的个人模板。PyCharm 将全局模板存储在IDE 配置目录中的fileTemplates下。
项目:配置特定于当前项目的文件模板。这些模板可供参与该项目的每个人使用。PyCharm 将它们存储在.idea/fileTemplates下的项目文件夹中。
在“文件”选项卡上,单击并指定模板名称、文件扩展名、生成的文件的名称以及模板的正文。
应用更改并关闭对话框。
复制现有文件模板
按打开 IDE 设置,然后选择编辑器 | 文件和代码模板。CtrlAlt0S
在“文件”选项卡上,单击并根据需要修改模板的名称、文件扩展名和正文。
应用更改并关闭对话框。
将文件另存为模板
在编辑器中打开文件。
在主菜单中,转到文件| 将文件另存为模板。
在“将文件另存为模板”对话框中,指定新模板名称、扩展名,并根据需要编辑正文。有关文件模板中使用的语法的详细信息,请参阅语法
应用更改并关闭对话框。
句法
文件模板使用Velocity 模板语言(VTL),其中包括以下结构:
开始输入$
或#
参考可用变量和指令的完成建议。
有关详细信息,请参阅VTL 参考指南。
以下示例显示了在 PyCharm 中创建 Gherkin 功能文件的默认模板:
# 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 文件时,此模板会生成一个功能文件,其内容类似于以下内容:
# Created by jetbrains at 25.06.2018
Feature: #Enter feature name here
# Enter feature description here
Scenario: # Enter scenario name here
# Enter steps here
感谢您的反馈意见!