idea file template（文件模板） 可以用的变量

有的时候博客内容会有变动，首发博客是最新的，其他博客地址可能会未同步, 认准https://blog.zysicyj.top

IDEA 文件模板中可以使用的变量

在使用 IntelliJ IDEA 创建文件模板时，使用变量可以极大地提高模板的灵活性和可复用性。本文将详细介绍一些常用的变量，并通过一个示例来展示它们的实际应用。

重点变量列表

  1. ${USER}
  2. ${DATE}
  3. ${TIME}
  4. ${YEAR}
  5. ${MONTH}
  6. ${DAY}
  7. ${HOUR}
  8. ${MINUTE}
  9. ${PROJECT_NAME}
  10. ${NAME}
  11. ${PACKAGE_NAME}
  12. ${CLASS_NAME}

示例：创建一个 Java 类文件模板

假设我们希望创建一个 Java 类文件模板，包含类的基本信息和作者、日期等注释。我们将使用上述变量来实现这一目标。

文件模板内容

首先，我们来看一下文件模板的内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/**
 * 类 ${NAME} 的实现描述：TODO 类实现描述
 * 
 * @author ${USER}
 * @date ${DATE} ${TIME}
 */
public class ${NAME} {
    
    public ${NAME}() {
        // TODO: 构造函数的实现
    }
    
    public static void main(String[] args) {
        System.out.println("Hello, ${NAME}!");
    }
}

变量详解

  1. ${USER}: 当前用户的用户名。这可以自动填充为创建文件的用户。
  2. ${DATE}: 当前日期，格式为 yyyy/MM/dd。
  3. ${TIME}: 当前时间，格式为 HH:mm。
  4. ${NAME}: 文件名或类名。在创建文件时会自动填充为输入的文件名。
  5. ${YEAR}、${MONTH}、${DAY}: 分别表示当前的年份、月份和日期。
  6. ${HOUR}、${MINUTE}: 分别表示当前的小时和分钟。
  7. ${PROJECT_NAME}: 当前项目的名称。
  8. ${PACKAGE_NAME}: 当前包的名称。对于 Java 类文件，这个变量非常有用。
  9. ${CLASS_NAME}: 类名，通常与 ${NAME} 相同。

示例解析

在这个模板中，我们使用了 ${USER} 来自动填充作者信息，使用 ${DATE} 和 ${TIME} 来记录文件创建的具体时间。${NAME} 用于表示类名和文件名，这样在创建新的类文件时，只需输入一次名称，模板中的所有相关地方都会自动填充。

实际效果

当我们在 IDEA 中使用这个模板创建一个名为 ExampleClass 的 Java 文件时，生成的文件内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/**
 * 类 ExampleClass 的实现描述：TODO 类实现描述
 * 
 * @author your_username
 * @date 2023/10/05 14:30
 */
public class ExampleClass {
    
    public ExampleClass() {
        // TODO: 构造函数的实现
    }
    
    public static void main(String[] args) {
        System.out.println("Hello, ExampleClass!");
    }
}

以上示例展示了如何通过 IDEA 文件模板中的变量来自动生成包含作者、日期等信息的 Java 类文件。这些变量不仅可以提高开发效率，还能确保代码的一致性和规范性。