コードスニペットをドキュメントに挿入する
コードスニペットプラグインを利用してコードスニペットをドキュメントに挿入します。1.挿入するコードスニペット
ここでは例として、「C/C++/ObjCのヘッダー」モードの「class」コードスニペットを挿入します。
「ショートカットキー」を定義していないので、「タブ」による挿入を行います。
2.モードの確認
「C/C++/ObjCのヘッダー」モードのコードスニペットを利用するので、現在のハイライトモードが「C/C++/ObjCのヘッダー」になっていることを確認します。
3.挿入するコードスニペットのキーを入力
挿入するコードスニペットのキー（「タブ」に表示されている文字列）を入力します。
4.コードスニペットの挿入
「Tab」キーを押すと、以下のようにコードスニペットが挿入されます。
「3.」で入力した文字列が、コードスニペットの文字列に置き換わります。
また、コードスニペットの編集モードが有効になります。
5.実線で囲われている文字列
挿入したコードスニペット内の実線で囲われている文字列は、「Tab」キーによりキャレットの移動が可能な文字列を示しています。この例では、「name」と「arguments」が実線で囲われています。
「name」にキャレットがある状態で「Tab」キーを押すと「arguments」にキャレットの移動します。
6.点線で囲われている文字列
挿入したコードスニペット内の点線で囲われている文字列は、同名の文字列を変更すると、まとめて変更される文字列を示しています。この例では、「name」が点線で囲われています。
現在選択されている「name」の文字列を編集すると、同様に点線で囲われている「name」の文字列も変更されます。
7.クラス名の入力
「5.」及び「6.」を踏まえた上で、クラス名を変更してみます。
クラス名を入力します。
8.クラス名の変更
クラス名を入力すると、関連する箇所がまとめて変更されます。
クラス名の変更なので、クラスのコンストラクターやデストラクターも、変更したクラス名に合わせて変更する必要があります。
コードスニペットには関連する箇所が定義されているため、関連した文字列も変更されます。
上記のように点線で囲われていた「name」の文字列が、入力したクラス名に自動的に変更されます。
9.コンストラクターの引数の変更
次に実線で囲われているコンストラクターの引数を変更してみます。クラス名を入力したらその状態のまま「Tab」キーを押します。
以下のように「arguments」にキャレットが移動し、「arguments」が選択された状態になります。
10.引数の入力
以下のように引数を入力します。
以上で完了です。
後は「Tab」キーを押すか、適当な場所をクリックすれば、コードスニペットの編集モードが解除されます。
