GhostDoc
10の必須ツール:全ての開発者がすぐにダウンロードすべき Visual Studio アドイン[MSDNマガジン2005年12月](閲覧はMSDNに登録が必要)
この記事に掲載されていた、Visual Studio .NET用のXMLコメント構文を生成してくれるアドインである、"GhostDoc"を実際に使ってみたが、とても使い勝手が良いので言及。
現在、Visual Studio 2003用と、Visual Studio 2005用の別々のアーカイブが用意されており、.NET1.1、.NET2.0のどちらの環境でも使用できるようだ。
GhostDocの使い方は非常に簡単であり、インストールしてVisual Studioを初めて起動する際にWizardが表示されて、GhostDocの初期設定をカスタマイズすることができる(スキップすることも可能)、あとは、メソッドやプロパティのシグネチャ上で、設定したショートカット、又はコンテキストメニューで"Document This"を選択することで、予め決められたルールに則ったXMLコメントを自動的に生成してくれる。
GhostDocでメソッドと、プロパティ用にXMLコメントを生成する例
何もカスタマイズを行なわないでとりあえず使ってみただけだが、上記の例のようにパラメタからコメント内容を推測して埋めてくれるのである。
この辺の語句は細かくカスタマイズできるようである。(私はまだ試してもいないが)
このコメント生成アドインと、NDocによるMSDN形式ドキュメントの自動生成があれば、.NETにおけるライブラリィリファレンスドキュメントの作成作業は、かなり楽ができそうだ。
