PhpStorm 2020.1ヘルプ

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

WindowsおよびLinux用のファイル | 設定 | エディター | ファイルおよびコード・テンプレート

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

PhpStorm creates files using file templates as described in ファイル・テンプレート . Use this page to view, edit, and create such templates .

Different groups of templates are located on different tabs.

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

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

項目説明
スキーム

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

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

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

タブ

タブ説明
ファイル

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

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

インクルード

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

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

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

コード

This tab displays built-in snippets — templates for code fragments that PhpStorm can generate in various typical situations, for example, for generating implemented or overridden method bodies.

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

ツールバー

項目ツールチップ説明
the Create Template buttonテンプレートの作成

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

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

the Remove Template buttonテンプレートの除去選択したテンプレートを削除するには、このボタンをクリックします。このオプションは、ファイルおよびインクルードタブの特定のテンプレートでのみ使用できます。
the Copy Template buttonテンプレートのコピー選択したテンプレートのコピーを作成するには、このボタンをクリックします。このオプションは、ファイルおよびインクルードタブでのみ使用できます。
the Reset to Default buttonデフォルトにリセット選択したテンプレートを元の状態に戻すには、このボタンをクリックします。このオプションは、変更されたテンプレート(このようなテンプレートは青色で強調表示されています)でのみ使用できます。
なしリセットこのリンクは、テンプレートの編集を開始するときにページの右上に表示されます。このリンクをクリックすると、保存されていない変更がすべてのタブのテンプレートにリセットされます。

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

項目説明
名前このフィールドは、新しいテンプレートが作成されたときに表示されます。新しいテンプレートの名前を指定してください。
拡張このフィールドには、拡張子を指定します。このタイプの新しいファイルが作成されると、PhpStormはこのテンプレートを適用します。
テンプレート・テキスト

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

  • プレーン・テキスト。

  • #parse directives to work with template includes.

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

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

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

    The following predefined variables can be used in file templates:

    変数説明
    ${DATE}現在のシステム日付
    ${DAY}今月の現在の日
    ${DS}ドル記号 $。この変数はドル記号をエスケープするために使用されるため、テンプレート変数の接頭辞としては扱われません。
    ${FILE_NAME}新しいPHPファイルの名前
    ${HOUR}現在の時間
    ${MINUTE}現在の分
    ${MONTH}現在の月
    ${MONTH_NAME_FULL}現在の月のフル・ネーム (1月、2月など)
    ${MONTH_NAME_SHORT}現在の月名の最初の3文字 (1月、2月など)
    ${NAME}新しいエンティティの名前 (ファイル、クラス、インターフェースなど)
    ${ORGANIZATION_NAME}プロジェクト設定で指定された組織の名前 ( Ctrl+Alt+Shift+S )
    ${NAMESPACE}クラスまたはフィールドの名前空間の完全修飾名(先頭にスラッシュなし)
    ${PRODUCT_NAME}IDEの名前 (たとえば、PhpStorm)
    ${PROJECT_NAME}現在のプロジェクトの名前
    ${TIME}現在のシステム時刻
    ${USER}現在のユーザーのログイン名
    ${YEAR}現在の年

    PhpStorm provides a set of additional variables for PHPインクルードテンプレート , which are used to define reusable pieces of code, such as file headers and PHPDoc コメント ).

    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$ ]]#

Thus, one can specify the cursor position. Note that it is required to use the live template variables here!

説明

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

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

最終更新日: 2020年6月01日