概要

コード スニペットとは

コード スニペットは、よく使うコードを簡単に記述できるようにする仕組みです。

一般的に、同じコードは何か所にも記述せず、メソッド化してコードを再利用するのが基本です。

しかし、メソッドの呼び出し手続きといった細かいレベルでの実装やコーディング スタイルの統一のために、同じコードを記述しなければならない場面が少なからずあります。

そのような場合には既存のコードをコピペ(コピー&ペースト)している方がほとんどだと思いますが、コピペよりもコード スニペットを利用することをお勧めします。

コード スニペットは次の点でコピペよりも優れています。

  1. コピーする必要がない
  2. 挿入時に置換可能な可変部分を定義できる
  3. 選択した部分の前後にコードを挿入できる

コード スニペットを使うメリット

1.コピーする必要がない

コード スニペットの仕組みではスニペット ファイルにコードを定義しておくため、コピー元のソース ファイルを開いてコードをコピーする必要がありません。

2.挿入時に置換可能な可変部分を定義できる

「コピペして名前の部分だけを書きかえる」という作業は、書き換えが漏れるとバグにつながります。しかも、書き換えが漏れていてもビルドエラーにならない場合、テストするまでバグに気づかない恐れがあります。

コード スニペットを使えば、書き換えたい部分を可変部分として定義でき、挿入時に入力を促すことができます。「a = a.ToLowerCase()」などのように複数ある「a」の部分を置換したいときにも、1つを入力すればすべてに反映されます。

3.選択した部分の前後にコードを挿入できる

たとえば、ある部分を try ~ catch で囲みたいといった場合、通常は近くに空のtryブロックを書いてから囲みたい部分をカット&ペーストするかと思います。コードスニペットを使うと、囲みたい部分を選択してコードスニペットの挿入コマンドを実行すると、一発で try ~ catch に囲まれた状態にできます。

また、前後に処理開始・終了のログ出力コードを追加したいようなときにも、開始と終了を別々に挿入するよりも確実に対になるように挿入できます。

このように、コード スニペットを使うことで、コピペよりも楽に、しかも安全に定型コードを実装できます。

敷居が高い?

しかし、コード スニペットの存在を知らなかったり、コード スニペットを定義するのが面倒そうだ、という理由からコード スニペットを利用していない方が多いのではないでしょうか。

そこで、コード スニペット活用のとっかかりになるような、コード スニペット定義の簡単な作成例を紹介します。