IntelliJ IDEA
 
2023.2
快捷方式：Windows
获取 IntelliJ IDEA
  1. 编写和编辑源代码
  2. 文件模板
  3. 文件模板变量

文件模板变量

最后修改时间：2023 年 8 月 24 日

文件模板可以包含变量，应用模板时这些变量将被其值替换。变量是一个以美元符号开头，$后跟变量名称的字符串。变量名称可以选择用花括号括起来。例如：$MyVariable和${MyVariable}是同一变量的不同表示法。

模板主体和文件名中提供了预定义和自定义变量。例如，如果您MyFile_${MONTH_NAME_FULL}在模板的“文件名”MyFile_April字段中输入，则生成的文件将被命名为您在四月份创建的文件。这里，${MONTH_NAME_FULL}是一个预定义变量。如果您改用自定义变量，IntelliJ IDEA 将在您基于此模板创建文件时提示您输入变量值。

预定义模板变量

文件模板中可以使用以下预定义变量：

多变的

描述

${DATE}

当前系统日期

${DAY}

当月的当前日期

${DIR_PATH}

从内容根目录到新文件目录的路径

${DS}

美元符号$。该变量用于转义美元字符，因此不会将其视为模板变量的前缀。

${FILE_NAME}

新 PHP 文件的名称（如果启用了PHP 插件）

${HOUR}

当前时间

${MINUTE}

当前分钟

${SECOND}

当前第二个

${MONTH}

这个月

${MONTH_NAME_FULL}

当前月份的全名（一月、二月等）

${MONTH_NAME_SHORT}

当前月份名称的前三个字母（Jan、Feb 等）

${NAME}

新实体的名称（文件、%class%、接口等）

${PACKAGE_NAME}

创建新类或接口文件的目标包的名称

${PRODUCT_NAME}

IDE 的名称（例如 IntelliJ IDEA）

${PROJECT_NAME}

当前项目名称

${TIME}

当前系统时间

${USER}

当前用户的登录名

${YEAR}

今年

自定义模板变量

除了预定义的模板变量之外，还可以指定自定义变量。如有必要，您可以使用指令在模板中定义自定义变量的值#set。在使用相应变量之前编写指令。

例如，如果您想使用您的全名而不是通过预定义变量定义的登录名${USER}，请在自定义变量之前添加以下构造：

#set( $MyName = "John Smith" )

如果模板中未定义变量的值，IntelliJ IDEA 将在应用模板时要求您指定它。

例如，您可以创建以下 Java 文件模板，每次基于此模板创建新文件时，该模板都会提示您输入方法的名称和该方法的参数：

#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

public class ${NAME} {
    static void ${MethodName}(String ${Parameter}) {
        System.out.println(${Parameter});
    }
}

在此示例中，我们使用${MethodName}和${Parameter}变量，但不设置它们的值。当您基于此模板创建文件时，IntelliJ IDEA 将要求您提供这些变量的值：

基于文件模板创建文件

在生成的文件中，变量将替换为您在新文件对话框中输入的值（本例中为方法和参数名称）：

package com.example.somepackage;

public class newClass {
    static void newMethod(String myName) {
        System.out.println(myName);
    }
}