PhpStorm 2019.3ヘルプ

ファイルおよびコード・テンプレート

WindowsとLinux用のファイル | 設定 | エディター | ファイルおよびコード・テンプレート
macOS用 PhpStorm | 環境設定 | エディター | ファイルおよびコード・テンプレート
Ctrl+Alt+S the Settings/Preferences icon


PhpStormはファイルテンプレートを使用してファイルを作成します。このページを使用して、そのようなテンプレートを表示、編集、および作成します。

異なるグループのテンプレートは、異なるタブに配置されています。

テンプレートを選択すると、その内容と説明がページの右側に表示されます。

プロジェクトごとのデフォルトスキーム

項目

説明

スキーム

ファイルとコードテンプレートの設定がワークスペース全体に関連するのか、現在のプロジェクトに関連するのかを選択します。

  • ファイルとコードのテンプレートがグローバルである場合、デフォルトスキームが選択されます。

  • 共有可能なプロジェクト固有のファイルとコードテンプレートを使用する場合は、プロジェクトスキームが選択されています。

タブ

タブ

説明

ファイル

このタブには、利用可能なファイルテンプレートが表示されます。

既存のテンプレートを編集したり、新しいテンプレートを作成したりすることができます。

インクルード

このタブには、ファイルテンプレートに含めることができる再利用可能なフラグメントのテンプレートが表示されます。

既存のテンプレートを編集したり、新しいテンプレートを作成したりすることができます。

PhpStormは、PHPクラス、フィールド、および関数(メソッド)用のPHPファイルヘッダーとPHPDoc コメントを生成するための事前定義された組み込みテンプレートセットを提供します。

コード

このタブには、組み込みのスニペット(実装されたメソッド本体やオーバーライドされたメソッド本体の生成など、さまざまな典型的な状況でPhpStormが生成できるコードフラグメントのテンプレートが表示されます)

既存のスニペットは編集できますが、新しいスニペットを作成することはできません。

ツールバー

項目

ツールチップ

説明

the Create Template button

テンプレートの作成

このボタンをクリックすると、現在開いているタブに新しいテンプレートが作成されます。このオプションは、ファイルおよびインクルードタブでのみ使用できます。

新しいテンプレートの場所はスキーマリストによって定義されます。

the Remove Template button

テンプレートの除去

選択したテンプレートを削除するには、このボタンをクリックします。このオプションは、ファイルおよびインクルードタブの特定のテンプレートでのみ使用できます。

the Copy Template button

テンプレートのコピー

選択したテンプレートのコピーを作成するには、このボタンをクリックします。このオプションは、ファイルおよびインクルードタブでのみ使用できます。

the Reset to Default button

デフォルトにリセット

選択したテンプレートを元の状態に戻すには、このボタンをクリックします。このオプションは、変更されたテンプレート(このようなテンプレートは青色で強調表示されています)でのみ使用できます。

なし

リセット

このリンクは、テンプレートの編集を開始するときにページの右上に表示されます。このリンクをクリックすると、保存されていない変更がすべてのタブのテンプレートにリセットされます。

テンプレートの設定と内容

項目

説明

名前

このフィールドは、新しいテンプレートが作成されたときに表示されます。新しいテンプレートの名前を指定してください。

拡張

このフィールドには、拡張子を指定します。このタイプの新しいファイルが作成されると、PhpStormはこのテンプレートを適用します。

テンプレート・テキスト

テンプレートの内容を編集します: 使用することができます:

  • プレーン・テキスト。

  • テンプレートに#parse ディレクティブが含まれています。

  • カスタム変数。変数の名前は、#set 指示文を使用してテンプレート内で直接定義することも、ファイルを作成する際に定義することもできます。

    PhpStormは、#setで定義されたVelocity変数の値を要求しません。

  • ${<variable_name>} 形式の対応する値に展開される変数。

    ファイルテンプレートでは、次の定義済み変数を使用できます。

    変数

    説明

    ${DATE}

    現在のシステム日付

    ${DAY}

    今月の現在の日

    ${DS}

    ドル記号 $。この変数はドル記号をエスケープするために使用されるため、テンプレート変数の接頭辞としては扱われません。

    ${FILE_NAME}

    新しいPHPファイルの名前

    ${HOUR}

    現在の時間

    ${MINUTE}

    現在の分

    ${MONTH}

    現在の月

    ${MONTH_NAME_FULL}

    現在の月のフル・ネーム (1月、2月など)

    ${MONTH_NAME_SHORT}

    現在の月名の最初の3文字 (1月、2月など)

    ${NAME}

    新しいエンティティの名前 (ファイル、クラス、インターフェースなど)

    ${ORGANIZATION_NAME}

    プロジェクト設定で指定された組織の名前 ( Ctrl+Shift+Alt+S )

    ${NAMESPACE}

    クラスまたはフィールドの名前空間の完全修飾名(先頭にスラッシュなし)

    ${PRODUCT_NAME}

    IDEの名前 (たとえば、PhpStorm)

    ${PROJECT_NAME}

    現在のプロジェクトの名前

    ${TIME}

    現在のシステム時刻

    ${USER}

    現在のユーザーのログイン名

    ${YEAR}

    現在の年

    PhpStormは、ファイルヘッダーやPHPDoc コメントなど、再利用可能なコードを定義するために使用されるPHPインクルードテンプレート用の一連の追加変数を提供します。

    PHPインクルードテンプレートでは、以下の追加定義済み変数を使用できます。

    変数

    説明

    ${CARET}

    変数の編集が終了したら、キャレットの位置を指定します。ファイル作成中にPHPDocコメントが生成されて挿入された場合にのみ適用されます。PHPDocコメントがコード | 生成 | PHPDocブロックを介して作成された場合、関数やメソッドの複数選択が可能です。この場合のドキュメントコメントは、いくつかのクラス、関数、メソッド、またはフィールドに対して作成することができるため、${CARET} 変数は無視されます。

    ${CLASS_NAME}

    PHPDocコメントを生成するフィールドまたはメソッドが定義されているクラスの名前

    ${NAME}

    PHPDocコメントが生成されるクラス、フィールド、または関数(メソッド)の名前

    ${NAMESPACE}

    クラスまたはフィールドの名前空間の完全修飾名(先頭にスラッシュなし)

    ${PARAM_DOC}

    パラメータのドキュメントコメント。一連の @param type name 行を評価します。コメントを生成する関数にパラメータが含まれていない場合は、空の文字列に評価されます。

    ${STATIC}

    PHPDocコメントを生成する関数(メソッド)またはフィールドが静的である場合は、static キーワードに置き換えられます。それ以外の場合は、空の文字列に評価されます。

    ${THROWS_DOC}

    例外のドキュメントコメント。一連の @throws type 行を評価します。コメントを生成する関数が例外をスローしない場合は、空の文字列に評価されます。

    ${TYPE_HINT}

    PHPDocコメントを生成する関数(メソッド)の戻り値。関数(メソッド)の静的解析によって戻り値の型を検出できない場合は、voidと評価されます。

    ドル記号の処理

    • テンプレート変数のドル記号 $ を接頭辞として扱うことを防ぐことができます。ドル記号($ をそのまま挿入する必要がある場合は、代わりに ${DS} ファイルテンプレート変数を使用します。テンプレートが適用されると、この変数は単純なドル記号 $に評価されます。

      例:

      • デフォルトクラステンプレートで一部のバージョン管理キーワード( $Revision$ , $Date$など)を使用するには、ドル記号 $の代わりに ${DS} を記述します。

      • テンプレートコード ${DS}this$thisとしてレンダリングされます。

スタイルに応じて再フォーマット

このチェックボックスをオンにすると、PhpStormはコードスタイルページで定義されたスタイルに従ってスタブファイルを再フォーマットします。

このオプションは、ファイルタブでのみ使用できます。

ライブ・テンプレートを使用可能にする

ファイルテンプレート内でライブテンプレートを使用するには、このチェックボックスをオンにします。そうすることで、ライブテンプレートフラグメントをVelocityエスケープ構文に入れる必要があります。

例:

#[[ $MY_VARIABLE$ $END$ ]]#

カーソルの位置を指定することができます。ライブテンプレート変数はここで使用する必要があります。

説明

この読み取り専用フィールドには、テンプレート、事前定義された変数、およびそれらが動作する方法に関する情報が表示されます。

このフィールドは、カスタムテンプレートでは使用できません。

最終更新日: 2019年12月9日

関連ページ:

テンプレート内の再利用可能なコンテンツ

テンプレートを含めるは、ディレクティブによって他のテンプレートに挿入される再利用可能なコード(標準ヘッダー、著作権ステートメントなど)を定義するために使用されます。組み込みのPHPインクルードテンプレートは、ファイルヘッダとPHPDocドキュメントコメントを生成するためのものです。独自のカスタムテン...

コード・スタイル

WindowsとLinux用のmacOS用スキーム:この領域では、コードスタイルスキームを選択し、必要に応じて変更します。コードスタイルスキームの設定は、PhpStormがコードを生成、リファクタリング、または再フォーマットするたびに自動的に適用されます。コードスタイルはプロジェクトレベルとIDEレ...

ライブテンプレート変数

ライブテンプレートの略語を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値または関数を使用して計算された値です。テンプレート内で変数を宣言するには、次の形式を使用します:。変数宣言として扱われないようにドル記号をテンプレート...

インスペクション

WindowsとLinux用のmacOS用このページを使用して、インスペクションプロファイルのカスタマイズ、インスペクションの重大度の設定、インスペクションの無効化と有効化、およびさまざまなスコープに対するインスペクションの設定を行います。このページは次の領域に分かれています。プロファイルを管理する...