文件模板

文件模板用于指定您通过文件 | 新建菜单或项目树中上下文菜单的新建部分创建的新文件的默认内容。

根据您要创建的文件类型，模板会提供该类型文件所需的初始代码和格式（可依据行业或语言标准、公司策略或其他原因）。

当您创建新文件时，PyCharm 会为所有受支持的文件类型提供建议的预定义模板。建议的文件类型集取决于模块和配置，以及您在项目工具窗口中当前位置的属性。例如，PyCharm 不会建议在 Python 源代码或测试目录之外创建 Python 文件。

有关详细信息，请参阅文件和代码模板。

默认情况下，模板列表仅包含由 PyCharm 提供的预定义模板。其中一部分为内部模板，这意味着它们无法删除或重命名。 PyCharm 以粗体显示内部模板的名称。您修改过的模板名称以及您手动创建的自定义模板会以蓝色显示。

以下过程介绍如何创建文件模板。创建包含模板也可使用类似过程。

按下 Ctrl+Alt+S 打开设置，然后选择编辑器 | 文件和代码模板。
在方案列表中，选择文件模板适用的范围：
- 默认：在 IDE 级别创建的文件模板。在当前 IDE 实例中打开的所有项目均可使用这些模板。将其作为您的个人模板使用，而不受具体项目的影响。 PyCharm 会将全局模板存储在位于 fileTemplates 下的 IDE 配置目录中。
- 项目：特定于当前项目的文件模板。参与此项目的所有人都可以使用这些模板。 PyCharm 会将其存储在位于 .idea/fileTemplates 下的项目文件夹中。
在文件选项卡上，点击，并指定模板名称、文件扩展名、生成的文件名以及模板主体。
应用更改并关闭对话框。

在编辑器中打开一个文件。
在主菜单中，转到文件 | 将文件另存为模板。
在将文件另存为模板对话框中，指定新的模板名称和扩展名，并在需要时编辑模板主体。有关文件模板所用语法的详细信息，请参见语法
- 文件名：如有需要，请为由此模板创建的文件指定名称。默认情况下，PyCharm 会在添加该文件时提示用户输入名称。您可以将特定名称硬编码以完全避免提示，或使用可用变量组合模板。例如，以下演示如何使用指定的名称，但将其放在创建文件时所选目录的上一级目录中： ../${NAME}
- 按照样式重新设置格式(R) ：根据为此文件类型定义的代码样式重新格式化基于此模板生成的内容。
- 启用实时模板(L) ：在文件模板中插入动态模板。使用 Velocity 转义语法将动态模板变量包含到文件模板中，例如： #[[ $MY_VARIABLE$ $END$ ]]#
应用更改并关闭对话框。

语法

文件模板使用 Velocity 模板语言（VTL），其中包括以下构造：

开始键入 $ 或 # 以查看可用变量和指令的补全建议。

有关详细信息，请参阅 VTL 参考指南。

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