文件模板变量

文章内容转载自IDEA官方帮助文档:File template variables | 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}，请在您的自定义变量之前添加以下构造：

<span style="background-color:var(--wh-color-backlight-main)"><span style="color:var(--wh-color-text-main)"><code>#set( $MyName = "John Smith" )</code></span></span>

复制！

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

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

<span style="background-color:var(--wh-color-backlight-main)"><span style="color:var(--wh-color-text-main)"><code><strong><span style="color:#0077aa">#if</span></strong> <span style="color:#999999">(</span><span style="color:#ee9900">$<span style="color:#999999">{</span>PACKAGE_NAME<span style="color:#999999">}</span></span> <span style="color:#9a6e3a">!=</span> <strong><span style="color:#669900">""</span></strong><span style="color:#999999">)</span>package <span style="color:#ee9900">$<span style="color:#999999">{</span>PACKAGE_NAME<span style="color:#999999">}</span></span>;<strong><span style="color:#0077aa">#end</span></strong>

public class <span style="color:#ee9900">$<span style="color:#999999">{</span>NAME<span style="color:#999999">}</span></span> {
    static void <span style="color:#ee9900">$<span style="color:#999999">{</span>MethodName<span style="color:#999999">}</span></span>(String <span style="color:#ee9900">$<span style="color:#999999">{</span>Parameter<span style="color:#999999">}</span></span>) {
        System.out.println(<span style="color:#ee9900">$<span style="color:#999999">{</span>Parameter<span style="color:#999999">}</span></span>);
    }
}</code></span></span>

复制！

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

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

<span style="background-color:var(--wh-color-backlight-main)"><span style="color:var(--wh-color-text-main)"><code><strong><span style="color:#0077aa">package</span></strong> com<span style="color:#999999">.</span>example<span style="color:#999999">.</span>somepackage<span style="color:#999999">;</span>

<strong><span style="color:#0077aa">public</span></strong> <strong><span style="color:#0077aa">class</span></strong> newClass <span style="color:#999999">{</span>
    <strong><span style="color:#0077aa">static</span></strong> <strong><span style="color:#0077aa">void</span></strong> <span style="color:#dd4a68">newMethod</span><span style="color:#999999">(</span><span style="color:#dd4a68">String</span> myName<span style="color:#999999">)</span> <span style="color:#999999">{</span>
        <span style="color:#dd4a68">System</span><span style="color:#999999">.</span>out<span style="color:#999999">.</span><span style="color:#dd4a68">println</span><span style="color:#999999">(</span>myName<span style="color:#999999">)</span><span style="color:#999999">;</span>
    <span style="color:#999999">}</span>
<span style="color:#999999">}</span></code></span></span>