PhpStorm 2024.3 ヘルプ

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

PhpStorm は、ファイルテンプレートで説明されているファイルテンプレートを使用してファイルを作成します。このページを使用して、そのようなテンプレートを表示、編集、作成します。

スキーム

ファイルテンプレートを適用するスコープを選択します。

  • デフォルト : IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。PhpStorm は、グローバルテンプレートを fileTemplatesIDE 構成ディレクトリに保存します。

  • プロジェクト : 現在のプロジェクトに固有のファイルテンプレート。これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。PhpStorm は、.idea/fileTemplates のプロジェクトフォルダーに保存します。

タブ

PhpStorm には、次のタイプのテンプレートが含まれています。

ファイル

PhpStorm は、ファイルテンプレートを使用して新しいファイルを作成します。

インクルード

これらは、ファイルテンプレートに含めることができる再利用可能なフラグメントのテンプレートです。詳細については、テンプレート内の再利用可能なコンテンツを参照してください。

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

コード

PhpStorm は、これらの組み込みテンプレートをスニペットとして使用して、さまざまな構成を生成します。

このタブで使用可能なテンプレートを編集して、PhpStorm がこれらの構成を生成する方法を変更できますが、新しい構成を作成することはできません。カスタムコードスニペットを作成するには、ライブテンプレートを使用します。

ツールバー

the Create Template button テンプレートの作成

新しいファイルを作成するか、テンプレートを含めます。

the Create Child Template File button 子テンプレートファイルの作成

選択したテンプレートに子テンプレートを追加して、1 つのテンプレートを持つ複数のファイルのセットを作成します。

the Remove Template button テンプレートの除去

選択したファイルを削除するか、テンプレートを含めます。削除できるのはカスタムテンプレートのみで、デフォルトのテンプレートは削除できません。

the Copy Template button テンプレートをコピー

選択したファイルのコピーを作成するか、テンプレートを含めます。

the Revert to Original Template button 元のテンプレートに戻す

選択したテンプレートを元の状態に戻します。変更されたデフォルトテンプレートのみを元に戻すことができます。

テンプレート設定

名前

UI に表示するテンプレートの名前を指定します。

デフォルトの組み込みテンプレートでは使用できません。

拡張

テンプレートを特定のファイルタイプに関連付けるファイル拡張子を指定します。

デフォルトの組み込みテンプレートでは使用できません。

ファイル名

必要に応じて、このテンプレートから作成されるファイルの名前を指定します。デフォルトでは、PhpStorm はファイルを追加するときにユーザーに名前の入力を求めます。特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。例: 指定した名前を使用して、ファイル作成時に選択したディレクトリの 1 つ上のディレクトリに置く方法を次に示します: ../${NAME}

デフォルトの組み込みテンプレートでは使用できません。

テンプレートエディター

選択したテンプレートに使用されるコードを編集します。ファイルテンプレートで使用される構文の詳細については、「構文」を参照してください。

スタイルに応じて整形

このファイルタイプに定義されたコードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。

このオプションは、ファイルテンプレートでのみ使用できます。

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

ファイルテンプレート内にライブテンプレートを挿入します。Velocity エスケープ構文を使用して、ライブテンプレート変数をファイルテンプレートに含めます(例: #[[ $MY_VARIABLE$ $END$ ]]#)。

関連ページ:

ファイルテンプレート

ファイルテンプレートは、プロジェクトツリーのコンテキストメニューのメニューまたは新規セクションを使用して作成する新しいファイルの既定の内容の仕様です。作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由に従って)。PhpStorm は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプの定義済みテンプレートを提供します。ファイルテンプレートの管...

ライブテンプレート変数

ライブテンプレートの省略形を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値、または関数を使用して計算された値である場合があります。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します(例:)。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定...

ファイルエンコーディング

PhpStorm は、これらの設定を使用して、エンコーディングを検出できなかったファイルを表示および編集し、指定されたエンコーディングを新しいファイルに使用します。PhpStorm がファイルまたはディレクトリのエンコーディングを特定できない場合、構成されたプロジェクトのエンコーディングにフォールバックします。プロジェクトがない場合、PhpStorm はグローバルエンコーディングを使用します。ファイルまたはディレクトリのエンコーディングはプロジェクトのエンコーディングよりも優先され、プロジェクト...