創建和編輯文件模板 · phpstorm手冊

# 創建和編輯文件模板 PhpStorm提供幾種方法來創建[文件模板](/如何使用/常規指南/文件和代碼模板/README.md)： * [從頭開始創建文件模板](#從頭開始創建文件模板) * [從已存在的一個創建文件模板](#從已存在的一個創建文件模板) * [從文件創建文件模板](#從文件創建文件模板) * [創建和引用包含模板](#創建和引用包含模板) ## **從頭開始創建文件模板** 1. [打開設置參數對話框](/如何使用/常規指南/配置項目和IDE設置/訪問設置.md)，在編輯器節點下，選擇[文件和代碼模板](/參考/設置參數對話框/編輯器/文件和代碼模板.md) 2. 切換到**Files**標簽頁 3. 在工具欄點擊![新增](http://image.jellychen.cn/uploads/2016/11/new.png)并指定模板名稱，文件擴展名，和模板的主體，可以包含： 1. 純文本。 2. `#parse`指令用來[包含](#創建和引用包含模板)文件 3. 預定義變量將被展開到相應的值，用以下格式`${<variable_name>}` 可用的預定義文件模板變量有： * `${PROJECT_NAME}` - 當前項目的名稱 * `${FILE_NAME}` - 將被創建的PHP文件名稱 * `${NAME}` - 在創建文件期間在新建文件對話框中指定的文件名稱 * `${USER}` - 系統的當前用戶登錄名稱 * `${DATE}` - 當前系統日期 * `${TIME}` - 當前系統時間 * `${YEAR}` - 當前年份 * `${MONTH}` - 當前月份 * `${DAY}` - 當前月的日期 * `${HOUR}` - 當前時刻 * `${MINUTE}` - 當前分鐘 * `${PRODUCT_NAME}` - 將被創建文件所在的IDE名稱 * `${MONTH_NAME_SHORT}` - 月份名稱的前3個字母，例如: Jan, Feb, etc. * `${MONTH_NAME_FULL}` - 月份全稱，例如: January, February, etc. PhpStorm為[PHP包含模板](/參考/設置參數對話框/編輯器/文件和代碼模板.md)提供一組額外變量，也就是，可重用模板可以被包含到其它**PHP file template**。內置**PHP file template**用于生成文件頭和[PHP文檔注釋](/如何使用/語言和框架-具體指南/PHP-具體指南/創建PHP注釋文檔.md)。下列變量在**PHP include templates**中可用： * `${NAME}` - PHP文檔注釋將被生成位置的類、字段或函數（方法）的名稱。 * `${NAMESPACE}` - 類或字段的命名空間的全稱(除了開頭的反斜杠)。 * `${CLASS_NAME}` - PHP文檔注釋將被生成位置所在類的名稱。 * `${STATIC}` - 獲取`static`如果要生成注釋位置的方法或字段是靜態的。否則變成一個空字符串。 * `${TYPE_HINT}` - 要生成注釋的函數的返回值提示。如果在函數靜態解析的過程中沒有發現返回值，它被作為`void`。 * `${PARAM_DOC}` - 參數的一個文檔注釋。展開為一行`@param type name`。如果要生成文檔的函數不包含注釋，這個變量被作為空內容。 * `${THROWS_DOC}` - 異常的一個注釋文檔。被作為一行`@throws type`。如果要生成文檔的函數沒有拋出異常，這個變量被作為空內容。 * `${DS}` - 一個美元(`{$}`)字符。這個變量被作為文本的美元字符(`{$}`)并被用來作為純符號而不被作為一個變量的前綴。 * `${CARET}` - 表明在生成文檔注釋之后插入符的位置。 `${CARET}`變量僅在PHP文檔注釋被生成和文件創建期間可用。當使用**Code | Generate | PHPDoc block**創建一個PHP文檔注釋，可以多選要創建文檔注釋的可用的函數和方法，如類、函數、方法或者字段。作為結果，PhpStorm可以“選擇”要應用`${CARET}`的代碼塊，因此在這種情況下`${CARET}`被忽略。 4. 自定義變量。它們的名字可以在模板中用`#set`指令定義或在文件創建期間定義。 4. 要使用原本的美元富符號`$`，使用`${DS}`文件模板變量。當應用模板時，這個變量被作為一個文本美元字符(`$`)。 5. 應用改變并保存對話框。 ## **從已存在的一個創建文件模板** 1. 打開[文件模板](/參考/設置參數對話框/編輯器/文件和代碼模板.md)設置頁面并切換到**Files**標簽頁。 2. 在工具欄點擊![復制按鈕](http://image.jellychen.cn/uploads/2016/11/copy.gif)，并然后修改模板名稱，擴展名，和所需的代碼 3. 應用改變并關閉對話框。 ## **從文件創建文件模板** 1. 在編輯器中打開目標文件 2. 在主菜單，選擇**Tools | Save File as Template** 3. 在打開的[文件和代碼模板](/參考/設置參數對話框/編輯器/文件和代碼模板.md)對話框指定新模板名稱并編輯代碼，如果需要的話。 4. 應用改變并關閉對話框。 ## **創建和引用包含模板** 包含模板用來定義可重用代碼塊來通過`#parse`指令插入到文件模板中。內置**PHP file template**用于生成文件頭和[PHP文檔注釋](/如何使用/語言和框架-具體指南/PHP-具體指南/創建PHP注釋文檔.md)。你也可以定義自己的模板。 1. 在[文件模板](/參考/設置參數對話框/編輯器/文件和代碼模板.md)設置頁面，切換到**Includes**標簽頁。 2. 在工具欄點擊![新增](http://image.jellychen.cn/uploads/2016/11/new.png)并指定模板名稱，文件擴展名，和代碼。做以下之一： * 使用[預定義文件模板變量](/如何使用/常規指南/文件和代碼模板/文件模板變量.md#預定義模板變量) * 創建自定義模板變量并在包含模板中使用`#set`VTL指令定義他們的值。例如，如果你想使用你的姓名而不是登錄名(通過預定義變量`${USER}`定義的)，寫以下的結構： ```VTL #set( $MyName = "John Smith" ) ``` 如果這個變量的值沒有在模板中定義，PhpStorm將在模板應用時詢問你來指定它。你可以防止在模板中美元符號`$`被作為變量前綴。如果你需要原本的美元富符號`$`，使用`${DS}`文件模板變量。當應用模板時，這個變量被作為一個文本美元字符(`$`)。 3. 要使用包含模板，切換到**Templates**標簽，選擇目標目標并點擊**Edit** 4. 要包含一個模板，在代碼中插入[#parse指令](/如何使用/常規指南/文件和代碼模板/解析指令.md) # 另請參閱：規程： * [從模板創建文件](/如何使用/常規指南/填充項目/從模板創建文件.md) 參考： * [文件和代碼模板](/參考/設置參數對話框/編輯器/文件和代碼模板.md) 概念： * [文件和代碼模板](/如何使用/常規指南/文件和代碼模板/README.md)