« トランス・オブ・ウォー | トップページ | バリアセグメント(完全版) »

Sandcastle(砂の城)

Sandcastle、日本語で砂の城だが別に砂場や砂浜での遊びではない。.NETで、ソースに書き込んだXMLドキュメントコメントをHELPファイルに変換するツールである。

しかし、ものは英語でしかもコマンドプロンプトアプリと来ている。以前は「敷居が高いなぁ」と思いつつやっては見たんだが結構手間がかかるのでもう一つ気乗りがしなかった。NDocは、かなり期待してたんだけど、こいつがどうも開発が止まっているらしく、ちょっといまさら新たには使えない。

コメントをドキュメントに変換するツールとしては、ほかにもdoxygenとかもある。doxygenそのものは、コマンドプロンプトのアプリだけどフロントエンドがあるので、それなりに使える。言語の制約も少ない。(Sandcastleは.NET専用である。)

ところが、HELP File Builderというフロントエンドが存在することを知り、一気に使いやすくなったので、自作クラスのドキュメントはこいつでいこうと決めました。できあがった、HELPファイルも、MSDN風で見た目もいいし、XMLコメントもそれほど難しくなく、LaTeXを使っている身としてはさほど苦にならない。なんと言っても、IDEがXMLコメントに対応しているのが大きい。C#だと///(スラッシュ3つ)、VB.NETだと'''(アポストロフィー3つ)を入力するだけで自動的にXMLコメントのモードになってくれるし、テンプレートも挿入してくれる。箇条書きや簡単な表も書けるので結構便利である。

NUnit+NCover+Sandcastle+TestDriven.NETがあれば、クラスの仕様書からテスト結果やカバレッジのレポートまでプログラミングしながら作成することができる。WORDやEXCELで、ちまちまとドキュメントを書いていくのは結構苦痛を伴うが、これはやっていて楽しい。やっぱり、プログラミングは、いくら仕事とはいえ楽しくなければ、やっている甲斐がない。

う~ん、便利になったものだ。あとは、中身だけだな・・・。

|

« トランス・オブ・ウォー | トップページ | バリアセグメント(完全版) »

パソコン・インターネット」カテゴリの記事

コメント

コメントを書く



(ウェブ上には掲載しません)




トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/203247/14649843

この記事へのトラックバック一覧です: Sandcastle(砂の城):

« トランス・オブ・ウォー | トップページ | バリアセグメント(完全版) »