Sandcastle – September 2007 Community Technology Preview (CTP)
"Sandcastle" は、、ソースコードの XMLコメントから、ドキュメントを自動生成してくれるツールで、同様のツールであり .NET 2.0 への対応をやめてしまった NDoc の後継だ。
MSDN のような HTML Help (*.chm) を作ることができ、.NET 2.0に対応している。
コマンドライン ツールであるが、"Sandcastle Help File Builder" のような GUI もある。
"Sandcastle" の最新版である "September 2007 Community Technology Preview (CTP)" が 10/1 に、出、10/4 に "Sandcastle Help File Builder" の最新版である "1.6.0.0" が出た。
早速使ってみた。
- "Sandcastle" と "Sandcastle Help File Builder" の最新版をダウンロード。
- "Sandcastle – September 2007 Community Technology Preview (CTP)" をインストール。(*1)
- デフォルトのパス (*2) に "Sandcastle Help File Builder (1.6.0.0)" をインストール。
- 「スタートメニュー」-「すべてのプログラム」-「Sandcastle Help File Builder」-「Build Reflection Data (first use)」を実行。 (*3)
- 「ビルドに成功しました。」と表示されるまで、かなり時間が掛かるが待つ。
- Visual Studio のプロジェクトのプロパティで「ビルド」-「出力」-「XML ドキュメント ファイル」をオンにする。
- Visual Studio からプロジェクトをビルド。
- 「スタートメニュー」-「すべてのプログラム」-「Sandcastle Help File Builder」-「Sandcastle Help File Builder GUI」を実行。
- Sandcastle Help File Builder の "Project Properties" の "Paths" の "OutputPath" を確認 (デフォルトでは ".\Help\")。
- Sandcastle Help File Builder の "Project Properties" の "Help File" の "HtmlHelpName" を確認 (デフォルトでは "Documentation")。(*4)
- Sandcastle Help File Builder の "Assemblies to Document" の "Add" でドキュメントを出力したいアセンブリを追加。
- Sandcastle Help File Builder のメニューから "Documentation" の "Build Project" を実行。
- ビルドが成功したことを確認。(*5)
- MSDN 形式のヘルプファイルが作成されていることを確認 (デフォルトでは ".\Help\Documentation.chm")。(*6)
(*1) 古いバージョンの Sandcastle がインストールされていた場合は、先にアンインストールする必要がある。
(*2) デフォルトのパスにインストールしないと 4 の手順に失敗する。
(*3) Vista の場合、権限が足りなくて実行に失敗することがある。その場合は、"Sandcastle Help File Builder" をインストールしたフォルダ内の "BuildReflectionData.bat" を「管理者として実行」する。
(*4) 新バージョンでは、"Project Properties" の "Help File" の "Language" の選択肢に「日本語(日本)」が出て来ない。
(*5) この時 public なクラスがなかったり XML コメントがないと、ビルドエラーになる。
(*6) 日本語に十分対応していないため、左側のペインのフォントの設定が不適切で文字化けを起こすことがある。
関連サイト: