VisualStudioでCode Snippetsは自作するとさらに気持ちいい

Last updated at 2017-12-22Posted at 2017-12-22

本記事はSilbird Advent Calendar 2017の23日目の記事です。

対象読者

VisualStudioを使って開発している人
VisualStudioをあまり使い慣れてない人
お気に入りのよく使うコードパターンがあったり、同じようなコードをたくさんかいている人¹

コードスニペットとは

簡素化された記述と操作でソースコードを挿入してくれる機能です。
今回は C# + VisualStudio でお届けします。

使うとどうなる？

百聞は一見にしかず、swと入力してTABを2回押すとさらさらとコードが出来上がっていきます。
個人的にはswitchにenumを食べさせるとCool

既定のスニペット

C#では既定でも便利なスニペットが揃っているので、気になった方は既定のスニペットを利用してみるとイメージが湧くと思います。

Visual C# のコードスニペット

個人的によく使うスニペットたち。

name	desc
ctor	コンストラクターの作成
prop	get,setが用意されたプロパティを作成
switch	switchブロックの作成

独自のコードスニペットを作る

xmlにて0から全部作ることもできます²が、今回は拡張機能のSnippet Dessignerを使用して作成します。

Snippet Designer

利用シーン想定

ここではデータアクセスを行うクラスを対応するDBのテーブル毎に作成する必要がある、というシチュエーション³で進めていきます。

例えば1つのテーブル毎に下記のようにクラスを作って全データ取得、一意検索、更新処理を実装していく必要があったとして。


    public class UserDataAdapter
    {
        public UserDataAdapter() { }

        const string ConnectionString = "Data Source=XXXX";

        public Task<IEnumerable<people>> GetAllData()
        {
            using (var con = new SqlConnection(ConnectionString))
            {
                return con.QueryAsync<people>("select * from people");
            }
        }

        public Task<people> GetByPK(int id)
        {
            using (var con = new SqlConnection(ConnectionString))
            {
                return con.QueryFirstAsync<people>("select * from people");
            }
        }

        public Task<int> UpdateByPK(int id, string name)
        {
            using (var con = new SqlConnection(ConnectionString))
            {
                return con.ExecuteAsync("update people set name = @name where id = @id", new { id, name });
            }
        }
    }