コード スニペット (C#)
更新 : 2007 年 11 月
Visual Studio には、コード スニペットと呼ばれる機能が用意されています。コード スニペットとは、コードに簡単に挿入できるようにあらかじめ用意されたコードの断片です。たとえば、for コード スニペットからは空の for ループが作成されます。一部のコード スニペットは、ブロックの挿入コード スニペットです。このコード スニペットでは、コードの行を選択してからコード スニペットを選択すると、コードの選択した行が取り込まれます。たとえば、コードの行を選択してから for コード スニペットをアクティブにすると、これらのコード行をループ ブロック内に含む for ループが作成されます。コード スニペットを使用すると、プログラム コードを短時間で簡単に作成でき、その信頼性を向上できます。
コード スニペットの使用
コード スニペットを使用するには、その Shortcut 要素 (IntelliSense コード スニペット) を入力し、Tab キーを 2 回押します。ショートカット名を持つスニペットが、C# でのコンプリート リストに表示されます。コンプリート リスト内で上方向キーと下方向キーを押すと、すべての有効なスニペット ショートカットを参照できます。
ショートカット値を持たないスニペットは、別の方法で使用する必要があります。コード エディタで Ctrl キーを押しながら K キーを押し、X キーを押すと、[スニペットの挿入] メニューが起動されます。メニューからスニペットを選択し、Tab キーまたは Enter キーを押します。詳細については、「方法 : コード スニペットを使用する (C#)」および「方法 : surround-with コード スニペットを使用する」を参照してください。
コード スニペットを選択すると、コード スニペットのテキストが自動的にカーソル位置に挿入されます。このとき、コード スニペット内の編集できるすべてのフィールドは黄色で強調表示され、1 番目の編集できるフィールドが自動的に選択されます。現在選択されているフィールドは、赤い四角で囲まれています。たとえば for コード スニペットの場合、編集できるフィールドは、初期化子変数 (既定では i) および長さ式 (既定では length) です。
フィールドが選択されている場合、ユーザーはそのフィールドの新しい値を入力できます。Tab キーを押すと、コード スニペットの編集できるフィールド間を移動できます。Shift キーを押しながら Tab キーを押すと、逆順に移動できます。フィールドをクリックすると、カーソルがそのフィールドに移動し、フィールドをダブルクリックすると、そのフィールドが選択されます。フィールドが強調表示されたとき、フィールドの説明を示すツールヒントが表示されることがあります。
各フィールドの 1 番目のインスタンスだけを編集できます。そのフィールドが強調表示されると、そのフィールドの他のインスタンスはアウトライン化されます。編集できるフィールドの値を変更すると、そのフィールドは、コード スニペット内で使用されているすべての場所で変更されます。
Enter キーまたは Esc キーを押すと、フィールドの編集はキャンセルされ、コード エディタは通常の状態に戻ります。
編集できるコード スニペット フィールドの既定の色を変更するには、[オプション] ダイアログ ボックスの [フォントおよび色] ペインの [コード スニペット フィールド] 設定を変更します。詳細については、「方法 : エディタで使用するフォントのフォント フェイス、サイズ、色を変更する」を参照してください。
コード スニペットの作成
既定で Visual Studio に含まれているコード スニペットだけでなく、カスタム コード スニペットを作成して使用できます。カスタム コード スニペットを作成する方法の詳細については、「コード スニペットの作成」を参照してください。
メモ : |
---|
C# コード スニペットの場合、[<ショートカット>] フィールドを指定するのに使用できる文字は、英数字、シャープ記号 (#)、ティルダ (~)、アンダースコア (_)、および半角ダッシュ (-) です。 |
既定で Visual C# に含まれるコード スニペットの詳細については、「既定のコード スニペット」を参照してください。