LiveTemplate / SurroundTemplateとは
要するにコードスニペット。標準のVisual Studioでforと打ってTab押したらfor文の雛型が生成されるやつ。
=>公式情報：ライブテンプレートを使用したソースコードの作成
サラウンドテンプレートは選択範囲をtry-catchブロックで囲ったり、lockで囲ったりする場合に使用。
Visual Studioでカスタムのコードスニペットを作るのはxmlファイルいじったりしてめんどくさいけど、Resharperなら簡単に作れる。
使い方
-
liveTemplateの使用例：自作のテストメソッド作成用テンプレート。"tm"と打ってEnter→テストしたいメソッドを入力。
- このように簡単に雛型を作れることがきちんとテストを書くモチベーションにもなる！
-
surroundTemplateの例：try-catchの例
- ショートカット無し
- try-catchで囲みたいブロックを選択→ブラシマークをクリック→[Surround With]→tryをクリック
- try-catchはよく書くのでショートカットを覚えると生産的
- [Ctrl + W]を数回押してメソッド全体選択→[Ctrl + E, Ctrl + U]でサラウンドテンプレートメニューを開く→[8]でtry-catchを選択
- [Ctrl + W]を数回押してメソッド全体選択→[Ctrl + E, Ctrl + U]でサラウンドテンプレートメニューを開く→[8]でtry-catchを選択
作り方
Live Templates
自分がよく使うテストメソッド生成テンプレートの作り方
- [Resharperメニュー]→[Tools]→[Templates Explorer...]を選択
- Templates Explorerが開く→[Live Templates]タブの[C#]が選択されている状態で新規作成ボタンを押す
3.下図のように編集して[Ctrl + s]で保存
- Shortcut : スニペットのショートカット
- Description : スニペット洗濯時の説明文
- 可変部分はドルマークで囲み、変数とする
→これで冒頭のGifのように"tm"と打つとコード補完でテストメソッド用のスニペットが選択できるようになる。
なお既存コードからテンプレートの雛型を作成することもできる。
1.テンプレート化したい範囲を選択
2.[Resharper]メニュー→[Tools]→[Create Live Templates from Selection...]を選択
3.雛型ができる
4.雛型を編集。shortcut, Descriptionを入力し、変数化したい部分をドルマークで囲む。
この例ではクラス名にマクロ[Containing type member name]にして、クラス名が自動で入るようにしている。
↓作成したテンプレートはこのように、使える
Surround Templatesの作り方
ほぼLiveTemplatesと同様。今回は[C#Tips.ログ]Disposable-usingを使った簡単計測ログ出力方法で紹介した計測ログ出力関数用usingのテンプレートを作成してみる
- [Resharperメニュー]→[Tools]→[Templates Explorer...]を選択
- Templates Explorerが開く→[Surround Templates]タブを選択、[C#]が選択されている状態で新規作成ボタンを押す
3.デフォルトの\$SELECTION$変数が選択範囲になるものとして編集して[Ctrl + s]で保存
↓このように使える。
まとめ
これ知っとくと楽やで^^。ほんの些細な定型句でもチマチマテンプレート化していくと、退屈な単純作業が楽しいテンプレート遊びと化す！
それでは良いプログラミングライフをﾉｼ