ファイルテンプレート
ファイルテンプレートは、プロジェクトツリーのコンテキストメニューのメニューまたは新規セクションを使用して作成する新しいファイルの既定の内容の仕様です。
作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由に従って)。
PhpStorm は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプの定義済みテンプレートを提供します。
ファイルテンプレートの管理と構成
Ctrl+Alt+S を押して設定を開き、を選択します。
詳細は、ファイルおよびコードテンプレートを参照してください。
デフォルトでは、テンプレートのリストには、PhpStorm によって提供される事前定義されたテンプレートのみが含まれています。それらのいくつかは内部的なものです。つまり、削除したり名前を変更したりすることはできません。PhpStorm は、内部テンプレートの名前を太字で示しています。変更したテンプレートの名前、および手動で作成したカスタムテンプレートは、青色で表示されます。
次の手順では、ファイルテンプレートを作成する方法について説明します。インクルードテンプレートの作成にも同様の手順を使用できます。
新しいファイルテンプレートを作成する
Ctrl+Alt+S を押して設定を開き、を選択します。
スキームリストを使用して、ファイルテンプレートが適用されるスコープを選択します。
デフォルト : IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。PhpStorm は、グローバルテンプレートを fileTemplates の IDE 構成ディレクトリに保存します。
プロジェクト : 現在のプロジェクトに固有のファイルテンプレート。これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。PhpStorm は、.idea/fileTemplates のプロジェクトフォルダーに保存します。
ファイルタブで、
をクリックし、テンプレート名、ファイル拡張子、結果のファイルの名前、テンプレートの本体を指定します。変更を適用し、ダイアログを閉じます。
既存のファイルテンプレートをコピーする
Ctrl+Alt+S を押して設定を開き、を選択します。
ファイルタブで、
をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。変更を適用し、ダイアログを閉じます。
ファイルをテンプレートとして保存する
エディターでファイルを開きます。
メインメニューで、に移動します。
「ファイルをテンプレートとして保存」ダイアログで、新しいテンプレート名と拡張子を指定し、必要に応じて本文を編集します。ファイルテンプレートで使用される構文の詳細については、「構文」を参照してください。
ファイル名 : 必要に応じて、このテンプレートから作成されるファイルの名前を指定します。デフォルトでは、PhpStorm はファイルを追加するときにユーザーに名前の入力を求めます。特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。例: 指定した名前を使用して、ファイル作成時に選択したディレクトリの 1 つ上のディレクトリに置く方法を次に示します:
../${NAME}スタイルに応じて整形 : このファイルタイプに定義されたコードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。
ライブテンプレートを使用可能にする : ファイルテンプレート内にライブテンプレートを挿入します。Velocity エスケープ構文を使用して、ライブテンプレート変数をファイルテンプレートに含めます（例:
#[[ $MY_VARIABLE$ $END$ ]]#）。
変更を適用し、ダイアログを閉じます。
構文
ファイルテンプレートは Velocity テンプレート言語 (英語)(VTL) を使用します。これには、次の構成が含まれます。
プレーンテキストはそのままレンダリングされます。
値に置き換えられる変数。例:
${NAME}は、ファイルを追加するときにユーザーが指定した名前を挿入します。#parse、
#set、#ifなどを含むさまざまなディレクティブ。
$ または # の入力を開始して、使用可能な変数およびディレクティブの補完候補を参照します。
詳細については、VTL リファレンスガイド(英語)を参照してください。
次の例は、PhpStorm で PHP クラスを作成するためのデフォルトのテンプレートを示しています。
このテンプレートは、次のように構成されています。
#parse指示文は、PHP File Header.phpテンプレートの内容を挿入するために使用されます。#ifディレクティブは、名前空間が空でないかどうかをチェックするために使用されます。そうでない場合は、その名前がnamespaceステートメントに${NAMESPACE}値として追加されます。テンプレートは、
${NAME}値（新しいファイルの名前）として渡された名前を持つクラスを宣言します。
テンプレートに基づいて新しい PHP クラスを作成すると、次のような内容のファイルが生成されます。
関連ページ：
ファイルおよびコードテンプレート
PhpStorm は、ファイルテンプレートで説明されているファイルテンプレートを使用してファイルを作成します。このページを使用して、そのようなテンプレートを表示、編集、作成します。スキームファイルテンプレートを適用するスコープを選択します。デフォルト: IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。PhpStorm は、グローバル...
ライブテンプレート変数
ライブテンプレートの省略形を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値、または関数を使用して計算された値である場合があります。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します（例:）。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定...
コード補完
このセクションでは、コーディングプロセスのスピードアップを可能にするコンテキスト対応コード補完のさまざまなテクニックについて説明します。基本補完：基本コード補完は、可視性スコープ内のクラス、メソッド、キーワードの名前を補完するのに役立ちます。コード補完を呼び出すと、PhpStorm はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します (提案にはライブテンプレートも含まれます)。基本コード補完がフィールド、パラメーター、変数宣言の一部に適用されている場合、PhpStor...
TODO コメント
時々、将来の参照のためにコードの一部をマークする必要があります: 最適化と改善の領域、起こり得る変更、議論される質問など。PhpStorm を使用すると、エディターでハイライトされ、インデックスが付けられ、TODO ツールウィンドウにリストされる特別なタイプのコメントを追加できます。この方法で、あなたのチームメイトは注意が必要な問題を追跡できます。デフォルトでは、PhpStorm によって認識される 2 つのパターン、とが小文字と大文字の両方で存在します。これらのパターンは行内で使用でき、サポート...