2011年1月23日日曜日

【VB.NET】プログラムリファレンス作成のSandCastle

Java でいう JavaDoc のようなプログラムリファレンスを作るためのソフト。
SandCastle





SandCastle を使用するために見ればいいリンクを羅列。

・まずSandcastle本体。

Sandcastle-June 2010 Release (Version 2.6.1062.1)
http://sandcastle.codeplex.com/releases/view/47665

・パッチをあてておこう

Sandcastle June 2010 (2.6.10621.1) Patch - Rev 1
http://sandcastlestyles.codeplex.com/releases/view/47767

・GUI環境を導入しよう

Sandcastle Help File Builder
http://shfb.codeplex.com/

・使い方を説明して頂いているリンク
http://blogs.wankuma.com/esten/archive/2007/09/12/95500.aspx
http://d.hatena.ne.jp/Wacky/20071007/1191782352


・通常に出力するとかなり時間がかかるのでMSDNへのリンクを切って高速化
http://narista.cocolog-nifty.com/gk/2007/06/sandcastle_f67f.html
※SdkLinkType が○○SdkLinkTypeとたくさんあるので注意


このソフトを使わない場合、プログラムのコメントはバラバラだわ、
プログラム内容の説明資料は作らないといけないだわ、
作った後も同期化しないといけないだわ、
と良いことなしですが、

メンバーにコメントをつける癖も付けられそうですし、すこぶる楽になりますね。

自分もリンクを忘れないようメモです。

GUIを使うやり方でやりましたが、CUIのコマンドラインでできるようになれば、
Windowsのタスクに組み込んで定期的に更新されるよう作れたりしますね。
非常に便利!

0 件のコメント:

コメントを投稿