@jsakamoto

Visual Studio 2005 で「名前」変更のリファクタリングを簡単に実行する方法

今回は、先日から続けている、「ヒゲ」機能紹介の最終回。

Visual Studio 2005 には「リファクタリング」機能が用意されていて、例えば、C# コードエディタ上でマウス右ボタンクリックでコンテキストメニューを表示させると、「リファクタ(R)」というメニュー項目が用意されている。

この内、「名前の変更」という機能（クラス名や変数名、メソッド名、といった「名前」）については、「ヒゲ」機能を使って、簡単に実行することもできる。

例えば、次のような C# コードを書いていたとする。


ここで、メソッドの引数 foo を my1stfoo に変更したいなぁ、と思いついたとする。そこで、そのまま C# コードエディタ上で、メソッド引数の箇所を普通に my1stfoo に書き換える。すると、Visual Stduio が変数名が変更されていることを感知して、「ヒゲ」を表示する。


そのまま、その「ヒゲ」をマウスでクリックするか、[Alt]+[Shift]+[F10] のキーコンビネーションを押すと、スマートタグが表示され、名前変更リファクタリングを実施するためのメニュー項目が表示される。


これを選べば、名前変更が実施される。


単純な文字列置換ではなく、ちゃんとスコープを考慮したり、外部参照などを検索したりして、変更してくれることろが賢い。もちろん、きょうび、リファクタ系のツールではこれくらい賢いのはあたりまえなのだろうが、標準環境で手軽に活用できる点は素直に歓迎してよいだろう。

以上、ここ数日間、Visual Studio 2005 の「ヒゲ」機能について紹介した。「ヒゲ」機能は目立つような目立たないような UI である。実際、私自身、この「ヒゲ」自体の存在には気づいていても、それが何をするものかわからず、ずっとさわらずにいて、随分と時間を無駄にしてしまった。「他にもこんなときにも「ヒゲ」が使えるよ！」などといったコメントなどあれば大歓迎である。

Visual Studio 2005 でメソッドスタブを自動生成する方法

先日から投稿している、Visual Studio 2005 の「ヒゲ」機能の続きである（この機能の正式名称をわかっていない）。

今回紹介するのは、メソッドスタブの自動生成である。

例えば次のような Hoge クラス（Hoge.cs にて記述されている）があったとしよう。


このHogeクラスを使ったプログラムを書いていたとする（前提条件として、Hoge.cs は同じソリューションに含まれていて、自由に変更可能だ）。


ここで、Hogeクラスに、"AskHoge" というメソッドが必要であることに気がついた。まだこの時点では Hoge クラスには AskHoge メソッドは無いわけだが、Hoge.cs の変更に取りかからず、このままあたかも AskHoge メソッドがあるかのようにコードを書いてしまう。


さて、すると Visual Studio 2005 の　C# コードエディタは、AskHoge メソッドが Hoge クラスには実在しないことを感知して、「ヒゲ」が表示される。

そのまま、その「ヒゲ」をマウスでクリックするか、[Alt]+[Shift]+[F10] のキーコンビネーションを押すと、スマートタグが表示され、そのメソッドのスタブを生成するためのメニュー項目が表示される。


これを選べば、そのメソッドのスタブが、Hoge.cs に追加される。


メソッドの戻り値の型や、引数の数、型を推測して、メソッドスタブを起こしてくれるので、けっこう実用になる。また、上記事例のように、Hogeクラスへの AskHoge メソッドの実装をとりあえず後回しにしたまま、現在のコーディング作業を続けられるので、思考を妨げずにプログラミングできるというメリットもある。

Visual Studio 2005 でインターフェースの実装スタブを生成する機能

先日投稿した記事にて、Visual Studio 2005 の「ヒゲ」機能を使って、足りない using を追加する方法を紹介した。

今回はその「ヒゲ」ネタの続きである。

あるクラスを作成していて、そのクラスにあるインターフェース（仮に IHoge というインターフェースとしよう）を実装させるとする。そうなると、IHoge インターフェースが備えているすべてのメソッドやプロパティなどをコーディングする必要がある（もちろん、抽象クラスを作るなら別）。

そんなとき、Visual Studio 2005 上で、C# でコーディング中ならば、クラス名の後ろにコロン（：）に続けてインターフェース名（この場合は IHoge）をタイプすると、「ヒゲ」が表示される。


そのまま、その「ヒゲ」をマウスでクリックするか、[Alt]+[Shift]+[F10] のキーコンビネーションを押すと、スマートタグが表示され、そのインターフェースの実装スタブを生成するためのメニュー項目が表示される。


これを選べば、そのインターフェースで必要とされるメソッドやプロパティなどのスタブが用意される。


とうぜん、メソッドやプロパティの内容は、単に「まだ実装していません」という例外をスローするだけであるが、しかし、スタブが用意されるだけでも作業は激減する。

.NET Framework で用意されているインターフェースの中には、けっこうな数のメソッドを持つものが少なくない。しかし、自分の用途にはそのうちいくつかを実装すれば十分、というケースも多々あり得る。そんな場合は自分で実装しないメソッドは例外をスローしていればよいので、まさにこの「ヒゲ」機能はうってつけである。

なお、ブログ「Kazzzの「JとNの狭間で」」で紹介されている ReSharper という Visual Studio のアドインでは、同様の機能を、"Implement/Override Members Wizard" という機能でもっとスマートに実現（実装するメソッド/プロパティを選択できたり、ドキュメントコメントをコピーしてくれたり）してくれるようだ。

Visual Studio 2005 で足りない using を自動で追加する機能

私は「Kazazの「JとNの狭間で」」というブログをRSSリーダーに登録しており、ちょくちょく新しいことを勉強させていただいている。NDoc 関連ではずいぶんとお世話になった。

さて、このブログの筆者がお勧めしている Visual Studio のアドインとして、Resharpen というプロダクトがある。なるほど、なかなか便利そうなのでかなりそそられる。

が、それはそれとして、上記ブログ筆者がブログ上で紹介している Resharpen の機能のうち、"Optimize Usings" については、Visual Studio 2005 でも類似の機能が用意されているので、Resharpen を導入せずとも便利に使える。


C# のコードエディタ上で、クラス変数を用意するためにクラス名までタイプすると、もし、ソースコード冒頭の using でネームスペースが予め指定されていないクラスであった場合は、即座に「ヒゲ」が表示される。


そのまま、その「ヒゲ」をマウスでクリックするか、[Alt]+[Shift]+[F10] のキーコンビネーションを押すと、Microsoft おなじみのスマートタグが表示され、冒頭に足りない using を追加するか、完全限定名に書き直すか、選択できる。

上記ブログにもあるとおり、ソースコードの先頭に戻らなくて良いのは、本当に便利である。

この機能、Visual Studio 2005 を使い始めてからも、ややしばらくは気がつかなかった。「ヒゲ」が表示されるのは気づいていたが、「例外ヘルパ」のように単に警告が出ているだけだろうという先入観のもと、「ヒゲ」にさわろうとしなかったのである。私と同様に、もしまだこの機能をご存じない希有な方（失礼！）にお知らせできたならば幸いである。

2006/11/01追記
Visual Basic では同様の機能があるのかどうか、残念ながら私は Visual Basic を使っていないのでわからない。

Smart Paster を拡張し、XML ドキュメントコメントを書きやすくする

C# ( VB でもそうだが ) の XML ドキュメントコメントは、クラスライブラリリファレンスの作成などに至極便利で、NDoc と組み合わせて社内での情報共有に一役買っている。

しかし、アプリケーション構成ファイルの例を XML ドキュメントコメントとして書き込もうとすると少々手間がかかる。

たとえば、

<appSettings>
<add key="foo" value="bar"/>
</appSettings>

というドキュメントを書きたい場合、(C#の) XML ドキュメントコメントには、

/// &lt;appSettings&gt;
/// &lt;add key="foo" value="bar"/&gt;
/// &lt;/appSettings&gt;

と、HTML エンコードしなくてはならない。

そこで、Smart Paster を拡張してみることにした。

Smart Paster は、Visual Studio 2003/2005 の Add-In で、クリップボードにコピーされているテキストを、様々な形式・編集にて貼り付けることができるよう、Visula Studio のコードエディタのコンテキストメニューを拡張する。詳しくは下記を参照。

http://weblogs.asp.net/alex_papadimoulis/archive/2004/05/25/Smart-Paster-1.1-Add-In---StringBuilder-and-Better-C_2300_-Handling.aspx

ソースが提供されているので、[Paste As]-[XML Document Comment] 機能を追加した。変更後のソースおよびビルド済みバイナリは下記。

ソース
http://www.stbbs.net/~junichi/archive/smart-paster-2005-xmldoccomment-enhanced/SmartPaster2005-XMLDocComment-enhanced-src.zip

ビルド済みバイナリ (インストーラ)
http://www.stbbs.net/~junichi/archive/smart-paster-2005-xmldoccomment-enhanced/SmartPaster2005-XMLDocComment-enhanced.vsi

これで貼り付け時に、HTML エンコードして貼り付けられるようになる。行頭の「///」 (VBなら ''') も自動的に挿入されるので快適。

GhostDoc (http://www.roland-weigelt.de/ghostdoc/) も併用することで、XML ドキュメントコメントの作成環境はかなり改善される。

ちなみに、Smart Paster や GhostDoc については、 MSDN マガジン日本語版 2005-12 から情報を入手。MSDN Flash ニュースレターを購読すれば読むことができる。