C# ( VB でもそうだが ) の XML ドキュメントコメントは、クラスライブラリリファレンスの作成などに至極便利で、NDoc と組み合わせて社内での情報共有に一役買っている。
しかし、アプリケーション構成ファイルの例を XML ドキュメントコメントとして書き込もうとすると少々手間がかかる。
たとえば、
<appSettings>
<add key="foo" value="bar"/>
</appSettings>
というドキュメントを書きたい場合、(C#の) XML ドキュメントコメントには、
/// <appSettings>
/// <add key="foo" value="bar"/>
/// </appSettings>
と、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 ニュースレターを購読すれば読むことができる。