IntelliJ IDEA文件模板變量

一個 IntelliJ IDEA 文件模板中包含了文件模板變量，當您應(yīng)用文件模板時，文件模板變量將被替換為它們的值。

文件模板變量是以美元符號開始的字符串，后跟變量名稱。變量名稱可以用大括號括起來。例如： $MyVariable 或 ${MyVariable}。

IntelliJ IDEA 預(yù)定義的文件模板變量

IntelliJ IDEA 附帶了一組預(yù)定義的模板變量。

可用的預(yù)定義文件模板變量是：

• ${PACKAGE_NAME} - 將在其中創(chuàng)建新類或接口的目標包的名稱。
• ${PROJECT_NAME} - 當前項目的名稱。
• ${FILE_NAME} - 將要創(chuàng)建的 PHP 文件的名稱。
• ${NAME} - 您在創(chuàng)建文件的過程中，在 "新建文件" 對話框中指定的新文件的名稱。
• ${USER} - 當前用戶的登錄名。
• ${DATE} - 當前系統(tǒng)日期。
• ${TIME} - 當前系統(tǒng)時間。
• ${YEAR} - 本年度。
• ${MONTH} - 本月。
• ${DAY} - 當月的當前日期。
• ${HOUR} - 當前時間
• ${MINUTE} - 當前分鐘。
• ${PRODUCT_NAME} - 將在其中創(chuàng)建文件的 IDE 的名稱。
• ${MONTH_NAME_SHORT} - 月份名稱的前3個字母。示例：1月，2月等。
• ${MONTH_NAME_FULL} - 一個月的全名。示例：1月，2月等

IntelliJ IDEA 為 PHP 包括模板提供了一組附加變量，即可被包含在其他 PHP 文件模板中的可重用片段的模板。內(nèi)置的 PHP 包含模板用于生成文件頭和 PHPDoc 文檔注釋。以下變量在 PHP 包含模板中可用：

• ${NAME} - 將為其生成 PHPDoc 注釋的類，字段或函數(shù)（方法）的名稱。
• ${NAMESPACE} - 類或字段命名空間的完全限定名（無斜杠）。
• ${CLASS_NAME} - 定義了生成 PHPDoc 注釋的字段的類的名稱。
• ${STATIC}- 如果要為其生成注釋的函數(shù) (方法) 或字段為靜態(tài)（static），則獲取靜態(tài)值。否則計算結(jié)果為空字符串。
• ${TYPE_HINT}- 提示函數(shù) (方法) 的返回值以生成注釋。如果無法通過函數(shù) (方法) 的靜態(tài)分析檢測到返回類型，則計算結(jié)果為 void。
• ${PARAM_DOC} - - 參數(shù)的文檔注釋。計算為一組 @param 類型名稱的行。如果要為其生成注釋的函數(shù)不包含任何參數(shù)，則該變量將計算為空內(nèi)容。
• ${THROWS_DOC} - 異常的文檔注釋。計算結(jié)果為一組 @throws 類型的行。如果要為其生成注釋的函數(shù)不拋出任何異常，則該變量將計算為空內(nèi)容。
• ${DS}- 一個美元字符（$）。該變量計算為一個簡單的美元字符（$），該變量的計算結(jié)果為純美元字符 ($)，當您需要轉(zhuǎn)義此符號時使用它，使其不被視為變量的前綴。
• ${CARET} - 指出了在生成和添加評論后插入符號的位置。${CARET}只有在文件創(chuàng)建期間生成和插入 PHPDoc 注釋時才應(yīng)用。當 PHPDoc 注釋是通過代碼| 生成| PHPDoc 塊（Code | Generate | PHPDoc block）創(chuàng)建的，可以使用多個函數(shù)或方法的選擇，因此文檔注釋可以創(chuàng)建到幾個類、函數(shù)、方法或字段。因此，IntelliJ IDEA 無法“選擇”塊來應(yīng)用 ${CARET} 變量，因此在這種情況下，該 ${CARET} 變量將被忽略。

IntelliJ IDEA 自定義文件模板變量

IntelliJ IDEA 中除了預(yù)定義的文件模板變量之外，還可以指定自定義變量。如有必要，您可以使用 #setVTL 指令在模板中定義自定義變量的值 。

例如，如果要使用您的全名，而不是通過預(yù)定義的變量 $ {USER} 定義的登錄名，請編寫以下結(jié)構(gòu)：

#set( $MyName = "John Smith" )

如果在模板中未定義變量的值，IntelliJ IDEA 將要求您在應(yīng)用模板時指定變量。

您可以防止將模板變量中的美元字符 ($) 作為前綴處理。如果您需要一個美元字符（插入值為 $），請改用 ${DS} 文件模板變量。當應(yīng)用模板時，此變量的計算結(jié)果為純美元字符 ($)。

IntelliJ IDEA 的 #parse 指令

使用 #parse 指令，您可以在文件模板中包括其他模板。這對于將可重用內(nèi)容（例如標準頭，版權(quán)聲明等）插入到多個文件模板中很有用。

該 #parse 指令的語法 是：

#parse("<template_name.extension>")

例如： #parse("File Header.java")。

在其他模板中可以像這樣引用的模板顯示在 "文件和代碼模板設(shè)置" 頁的 "包含" 選項卡上。