文件模板
文件模板是新建文件的默认内容定义,您可以通过 菜单或项目树上下文菜单中的 新建 区域创建新文件。
根据所创建文件的类型,模板提供该类型所有文件中所期望的初始代码和格式(依据行业或语言标准、公司策略或其他原因)。
GoLand 提供所有受支持文件类型的预定义模板供新建文件时选择。 建议的文件类型集合取决于模块与配置,以及 项目 工具窗口中当前位置的属性。 例如,在 Java 源代码目录或测试目录之外,GoLand 不会建议创建 Java 类文件。
管理并配置文件模板
按下 Ctrl+Alt+S 打开设置,然后选择 。
有关更多信息,请参阅 文件与代码模板。
默认情况下,模板列表仅包含由 GoLand 提供的预定义模板。 其中一些为内部模板,无法删除或重命名。 GoLand 以加粗字体显示内部模板的名称。 您修改过的模板以及手动创建的自定义模板,其名称以蓝色显示。
下列过程描述了如何创建文件模板。 类似的步骤也可用于创建 include 模板。
创建新文件模板
按下 Ctrl+Alt+S 打开设置,然后选择 。
使用 方案 列表选择文件模板适用的作用域:
默认 :在 IDE 级别创建的文件模板。 这些模板在当前 IDE 实例打开的所有项目中均可使用。 可将其用作个人模板,无论具体项目如何,皆可使用。 GoLand 会将这些全局模板存储在 IDE 配置目录 下的 fileTemplates 中。
项目 :当前项目专属的文件模板。 这些模板对参与该项目的所有人员可用。 GoLand 会将这些模板存储在项目目录下的 .idea/fileTemplates 中。
在 文件 选项卡中,点击
,并指定模板名称、文件扩展名、生成的文件名称以及模板正文。
应用更改并关闭对话框。
复制现有文件模板
按下 Ctrl+Alt+S 打开设置,然后选择 。
在 文件 选项卡中,点击
,并根据需要修改模板名称、文件扩展名以及模板正文。
应用更改并关闭对话框。
将文件保存为模板
在编辑器中打开文件。
在主菜单中,转到 。
在 将文件另存为模板 对话框中,指定新模板的名称、扩展名,并根据需要编辑正文。 有关文件模板中使用语法的更多信息,请参见 语法
文件名 :如有必要,为从此模板创建的文件指定一个名称。 默认情况下,GoLand 会在添加文件时提示用户输入名称。 您可以硬编码特定名称以完全跳过提示,也可结合使用可用变量来组成模板。 例如,以下方式可以使用指定名称,但将其放在用户创建文件时选择的目录的上一级目录中:
../${NAME}按照样式重新设置格式(R) :根据该文件类型定义的 代码样式 ,重新格式化此模板生成的内容。
启用实时模板(L) :在文件模板中插入 live templates。 使用 Velocity 转义语法将 live template 变量 插入文件模板中,例如:
#[[ $MY_VARIABLE$ $END$ ]]#
应用更改并关闭对话框。
语法
文件模板使用 Velocity 模板语言 (VTL),其包含以下结构:
开始输入 $ 或 # 以引用可用变量和指令的 补全建议。
有关详细信息,请参阅 VTL 参考指南。
以下示例展示了在 GoLand 中创建 JavaScript 类的默认模板:
在此模板中, ${USER} 和 ${DATE} 是模板变量。
创建新的 JavaScript 文件时,此模板会生成一个内容类似如下的文件: