創(chuàng)建和編輯IntelliJ IDEA文件模板

2018-10-13 15:23 更新

IntelliJ IDEA 創(chuàng)建文件模板

  1. 打開“設(shè)置/首選項(xiàng)”對(duì)話框,并在編輯器節(jié)點(diǎn)下選擇文件和代碼模板頁面。
  2. 切換到 "文件" 選項(xiàng)卡。
  3. 單擊工具欄上的 圖標(biāo),并指定模板名稱、文件擴(kuò)展名和模板正文,該模塊可以包含以下內(nèi)容:
    • 純文本。
    • #parse 指令與包含一起使用。
    • 要擴(kuò)展為格式 $ {<variable_name>} 的相應(yīng)值的預(yù)定義變量。
      可用的預(yù)定義文件模板變量是:
      • ${PACKAGE_NAME} - 將創(chuàng)建新類或接口的目標(biāo)包的名稱。
      • ${PROJECT_NAME} - 當(dāng)前項(xiàng)目的名稱。
      • ${FILE_NAME} - 將要?jiǎng)?chuàng)建的 PHP 文件的名稱。
      • ${NAME} - 在創(chuàng)建文件的過程中,在 "新建文件" 對(duì)話框中指定的新文件的名稱。
      • ${USER} - 當(dāng)前用戶的登錄名。
      • ${DATE} - 當(dāng)前系統(tǒng)日期。
      • ${TIME} - 當(dāng)前系統(tǒng)時(shí)間。
      • ${YEAR} - 本年度。
      • ${MONTH} - 當(dāng)月。
      • ${DAY} - 當(dāng)月的當(dāng)前日期。
      • ${HOUR} - 當(dāng)前時(shí)間。
      • ${MINUTE} - 當(dāng)前分鐘。
      • ${PRODUCT_NAME} - 將在其中創(chuàng)建文件的 IDE 的名稱。
      • ${MONTH_NAME_SHORT} - 月份名稱的前3個(gè)字母。示例:1月,2月等。
      • ${MONTH_NAME_FULL} - 一個(gè)月的全名。示例:1月,2月等。
      IntelliJ IDEA 為 PHP 包括模板提供了一組附加變量,即可以包含在其他 PHP 文件模板內(nèi)容中的可重用片段的模板。內(nèi)置的 PHP 包含模板用于生成文件頭和 PHPDoc 文檔注釋。下列變量在 PHP 包含模板中可用:
      • ${NAME} - 將為其生成 PHPDoc 注釋的類、字段或函數(shù)(方法)的名稱。
      • ${NAMESPACE} - 類或字段命名空間的完全限定名(無斜杠)。
      • ${CLASS_NAME} - 定義了生成 PHPDoc 注釋的字段的類的名稱。
      • ${STATIC}- 如果要為其生成注釋的函數(shù) (方法) 或字段為靜態(tài)(static),則獲取靜態(tài)值。否則計(jì)算結(jié)果為空字符串。
      • ${TYPE_HINT}- 提示函數(shù) (方法) 的返回值以生成注釋。如果無法通過函數(shù) (方法) 的靜態(tài)分析檢測到返回類型,則計(jì)算結(jié)果為 void。
      • ${PARAM_DOC} - 參數(shù)的文檔注釋。計(jì)算為一組 @param 類型名稱的行。如果要為其生成注釋的函數(shù)不包含任何參數(shù),則該變量將計(jì)算為空內(nèi)容。
      • ${THROWS_DOC} - 異常的文檔注釋。計(jì)算結(jié)果為一組 @throws 類型的行。如果要為其生成注釋的函數(shù)不拋出任何異常,則該變量將計(jì)算為空內(nèi)容。
      • ${DS}- 一個(gè)美元字符 ($)。該變量的計(jì)算結(jié)果為純美元字符 ($),當(dāng)您需要轉(zhuǎn)義此符號(hào)時(shí)使用它,使其不被視為變量的前綴。
      • ${CARET} - 指出了在生成和添加評(píng)論后插入符號(hào)的位置。
        僅當(dāng)在創(chuàng)建文件期間生成并插入 PHPDoc 注釋時(shí),才應(yīng)用此變量。當(dāng) PHPDoc 注釋是通過代碼| 生成| PHPDoc 塊(Code | Generate | PHPDoc block)創(chuàng)建的, 可以使用多個(gè)函數(shù)或方法的選擇,因此文檔注釋可以創(chuàng)建到幾個(gè)類、函數(shù)、方法或字段。因此,IntelliJ IDEA 無法“選擇”塊來應(yīng)用 ${CARET} 變量,因此在這種情況下,該 ${CARET} 變量將被忽略。
    • 自定義變量。它們的名稱可以通過 #set 指令在模板中定義,也可以在文件創(chuàng)建過程中進(jìn)行定義。
  4. 若要將美元字符 ($) 放在呈現(xiàn)為 "as" 的變量中,請(qǐng)改用 ${DS} 變量。此變量的計(jì)算結(jié)果為純美元字符 ($)。
  5. 應(yīng)用更改并關(guān)閉對(duì)話框。

IntelliJ IDEA 從現(xiàn)有文件夾創(chuàng)建文件模板

  1. 打開 "文件模板設(shè)置" 頁并切換到 "文件" 選項(xiàng)卡。
  2. 單擊工具欄的 圖標(biāo),根據(jù)需要更改模板名稱、擴(kuò)展名和源代碼。
  3. 應(yīng)用更改并關(guān)閉對(duì)話框。

IntelliJ IDEA 從文件創(chuàng)建文件模板

  1. 在編輯器中打開所需的文件。
  2. 在主菜單上選擇工具|將文件另存為模板(Tools | Save File as Template)。
  3. 在 "文件和代碼模板" 對(duì)話框中指定新模板的名稱,并在必要時(shí)編輯源代碼。
  4. 應(yīng)用更改并關(guān)閉對(duì)話框。

IntelliJ IDEA 創(chuàng)建和引用包含模板

IntelliJ IDEA 中包含模板用于通過 #parse 指令定義要插入到文件模板中的可重用代碼段。

  1. 在 "文件和代碼模板設(shè)置" 頁中,切換到 "包含" 選項(xiàng)卡。
  2. 單擊工具欄的 圖標(biāo),并指定模板名稱、擴(kuò)展名和源代碼。執(zhí)行以下操作之一:
    • 使用預(yù)定義的文件模板變量。
    • 創(chuàng)建自定義模板變量,并使用 #set VTL 指令在包含(include) 模板中直接定義它們的值 。例如,如果要在文件頭中插入您的全名,而不是通過 $ {USER} 定義的登錄名,則編寫以下結(jié)構(gòu):
      #set( $MyName = "John Smith" )
      如果在應(yīng)用模板時(shí),某些模板變量的值未知,IntelliJ IDEA 將要求您指定它們。
    • 您可以防止將模板變量中的美元字符 ($) 作為前綴處理。如果您需要一個(gè)美元字符(插入值為 $),請(qǐng)改用 $ {DS} 文件模板變量。當(dāng)應(yīng)用模板時(shí),此變量的計(jì)算結(jié)果為純美元字符 ($)。
    • 若要使用 "包含" 模板,請(qǐng)切換到 "模板" 選項(xiàng)卡,選擇所需的模板,并單擊“編輯”。
    • 要包含模板,請(qǐng)?jiān)谠创a中插入 #parse 指令。
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)