PhpStorm 2021.1 ヘルプ

ライブテンプレートを作成する

次の手順例は、現在の日付とユーザー名で TODO コメントのテンプレートを作成する方法を示しています。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | ライブテンプレートに移動します。

  2. 新しいライブテンプレートを作成するテンプレートグループ(たとえば、other)を選択します。

    テンプレートグループを選択しない場合、ライブテンプレートがユーザーグループに追加されます。

  3. the Add button をクリックし、ライブテンプレートを選択します。

  4. 略語フィールドで、テンプレートの展開に使用される文字を指定します。例: todo

  5. (オプション)説明フィールドに、将来の参照用にテンプレートを記述します。

    次に例を示します: Insert TODO comment with the current date and username

  6. テンプレートテキストフィールドで、変数を使用してテンプレートの本文を指定します。

    次に例を示します: //TODO $DATE$ $USER$: $END$

  7. 使用して変数を定義する変数の編集をクリックして機能を:

    名前 デフォルト値 定義済みはスキップ
    DATEdate() なし はい
    USERuser() なし はい

    式の評価に失敗した場合のデフォルト値を設定できますが、これらの特定の関数は常に有効な値を返す必要があります。変数の定義済みはスキップオプションを無効にして、展開された値をハイライトし、必要に応じてユーザーが変更できるようにすることもできます。

  8. すべての変更を適用します。

  9. エディターで todo と入力し、Tab を押します。

    現在のシステム日付とユーザー名に応じて、テンプレートは次のように展開されます。

    //TODO 02.07.2019 jsmith:

コードの断片から新しいテンプレートを作成する

  1. エディターで、テキストフラグメントを選択してライブテンプレートを作成します。

  2. メインメニューからツール | ライブテンプレートとして保存を選択します。ライブテンプレートのリストが開きます。このリストでは、新しく作成されたテンプレートがユーザーグループに追加されています。

  3. テンプレートの省略形、オプションの説明(テンプレートの目的を識別するため)を指定し、テンプレート本体を変更します。テンプレートに変数が定義されている場合は、変数の編集をクリックして設定します。

  4. 変更を適用するには、OK をクリックします。

既存のテンプレートをコピーする

同じテンプレートを複数のグループで再利用する場合、または別のテンプレートに基づいて新しいテンプレートを作成する場合は、既存のテンプレートを複製できます。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+Sエディター | ライブテンプレートページで、コピーするテンプレートを選択します。

  2. ツールバーの複製 The Duplicate button をクリックします。新しいテンプレートアイテムがオリジナルと同じグループに追加され、選択されます。

  3. テンプレートの新しい省略形、オプションの説明(テンプレートの目的を識別するため)を指定し、必要に応じてテンプレート本体を変更します。テンプレートに変数が定義されている場合は、変数の編集をクリックして設定します。

  4. 変更を適用するには、OK をクリックします。