ライブテンプレートを作成する
次の手順例は、現在の日付とユーザー名で TODO
コメントのテンプレートを作成する方法を示しています。
Ctrl+Alt+S を押して設定を開き、
を選択します。新しいライブテンプレートを作成するテンプレートグループ(たとえば、other)を選択します。
テンプレートグループを選択しない場合、ライブテンプレートがユーザーグループに追加されます。
をクリックし、ライブテンプレートを選択します。
テンプレートが使用可能になるコンテキストを指定します。デフォルトでは、コンテキストは指定されておらず、PhpStorm はダイアログの下部にメッセージを表示します。
メッセージの定義をクリックし、該当するコンテキストの横にあるチェックボックスを選択します。
略語フィールドで、テンプレートの展開に使用される文字を指定します。例:
todo
(オプション)説明フィールドに、将来の参照用にテンプレートを記述します。
次に例を示します:
Insert TODO comment with the current date and username
テンプレートテキストフィールドで、変数を使用してテンプレートの本文を指定します。
次に例を示します:
//TODO $DATE$ $USER$: $END$
使用して変数を定義する変数の編集をクリックして機能を:
名前
式
デフォルト値
定義済みはスキップ
DATE
date()
なし
はい
USER
user()
なし
はい
式の評価に失敗した場合のデフォルト値を設定できますが、これらの特定の関数は常に有効な値を返す必要があります。変数の定義済みはスキップオプションを無効にして、展開された値をハイライトし、必要に応じてユーザーが変更できるようにすることもできます。
すべての変更を適用します。
エディターで
todo
と入力し、Tab を押します。現在のシステム日付とユーザー名に応じて、テンプレートは次のように展開されます。
//TODO 02.07.2019 jsmith:
コードの断片から新しいテンプレートを作成する
エディターで、テキストフラグメントを選択してライブテンプレートを作成します。
メインメニューからユーザーグループに追加されています。
を選択します。ライブテンプレートのリストが開きます。このリストでは、新しく作成されたテンプレートがテンプレートの省略形、オプションの説明(テンプレートの目的を識別するため)を指定し、テンプレート本体を変更します。テンプレートに変数が定義されている場合は、変数の編集をクリックして設定します。
変更を適用するには、OK をクリックします。
既存のテンプレートをコピーする
同じテンプレートを複数のグループで再利用する場合、または別のテンプレートに基づいて新しいテンプレートを作成する場合は、既存のテンプレートを複製できます。
設定ダイアログ(Ctrl+Alt+S)の ページで、コピーするテンプレートを選択します。
ツールバーの複製 をクリックします。新しいテンプレートアイテムがオリジナルと同じグループに追加され、選択されます。
テンプレートの新しい省略形、オプションの説明(テンプレートの目的を識別するため)を指定し、必要に応じてテンプレート本体を変更します。テンプレートに変数が定義されている場合は、変数の編集をクリックして設定します。
変更を適用するには、OK をクリックします。
関連ページ:
ライブテンプレート変数
ライブテンプレートの略語を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値または関数を使用して計算された値です。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します(例:)。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定義されている他の変数...
ライブテンプレート
ライブテンプレートを使用して、ループ、条件、宣言、print ステートメントなどの一般的な構造をコードに挿入します。コードスニペットを展開するには、対応するテンプレートの省略形を入力してを押します。を押し続けると、テンプレート内の 1 つの変数から次の変数に移動します。を押して、前の変数に移動します。ライブテンプレートの種類:次のタイプのライブテンプレートが区別されます。シンプルなテンプレートには固定プレーンテキストのみが含まれています。シンプルなテンプレートを展開すると、テキストが自動