シンプルプレースホルダー
「シンプルプレースホルダー」は、スニペット挿入時にユーザーが編集する文字列の箇所を定義する「プレースホルダー」です。シンプルプレースホルダーのフォーマット
「シンプルプレースホルダー」のフォーマットは、以下のようになります。
${番号}
番号について
番号は1以上の数値を指定します。番号は、「プレースホルダー」間を移動する順番になります。
最も小さい番号を指定された「シンプルプレースホルダー」は、スニペットをドキュメントに挿入した時に、一番最初にフォーカス(キャレット)がセットされます。
また、番号の小さい順に「プレースホルダー」間を移動することができます。
番号は連番である必要も「1」から始める必要もありませんが、分かりやすい番号を指定しておきましょう。
デフォルト値を指定するには
「シンプルプレースホルダー」はデフォルト値を設定することができます。スニペットをドキュメントに挿入した時に、デフォルト値がそのままドキュメントに展開されます。
以下のように記述します。
${番号:デフォルト値}
スニペットの記述例
スニペットの記述例です。「シンプルプレースホルダー」を3つ使用しています。
また各「シンプルプレースホルダー」にデフォルト値を設定しています。
リスト
${1:アイテム1},${2:アイテム2},${3:アイテム3}
${1:アイテム1},${2:アイテム2},${3:アイテム3}
スニペットの使用例
ドキュメントに上記のスニペットを挿入すると、以下のようになります。1.タブの入力
スニペットを挿入するため、上記のスニペットに設定してある「タブ」を入力します。2.スニペットの挿入
「Tab」キーを押すと、以下のようにスニペットの内容がドキュメントに展開されます。「シンプルプレースホルダー」は、実線の枠で表示されます。
各「シンプルプレースホルダー」にデフォルト値を設定しているため、「アイテム1」といったデフォルト値がドキュメントに展開されています。
また、すべての「プレースホルダー」の中で最も番号の小さい「${1:アイテム1} 」に、フォーカスが設定されています。