これまでは、Sandcastleに同梱されているコマンドラインツールについて紹介してきましたが、最後に操作性に優れたSandcastle Help File Builderというソフトウェアについて紹介します。

(4)Sandcastle Help File Builderによるヘルプの生成

Sandcastle Help File Builderは、グラフィカルなユーザインタフェースでSandcastleを操作できるソフトウェアです。オープンソースとして開発されているためCodePlexから無償でダウンロードできます。バージョン1.7.0.0のZIPファイルを入手して解凍し、インストーラ「SandcastleBuilderSetup.msi」を実行します。インストールが完了したら、スタートメニューからSandcastle Help File Builder GUIを選択して起動します。

Sandcastle Help File Builderのメイン画面

この画面の基本的な操作手順は次のようになります。

(1) Addボタンを押して、ヘルプリファレンスを生成したいアセンブリを選択する
(2) HelpTypeFormatプロパティで、ヘルプの形式(1.x、2.x、WebSite)を選択する
(3) Languageプロパティで、「日本語 (日本)」を選択する
(4) PresentationStypeプロパティで、スタイル(hana,vs2005,prototype)を選択する
(5) Projectメニューの［Save Project］で、プロジェクトを保存する(*.shfb形式)
(6) Documentationメニューの［Build Project］を選択して、ヘルプを生成する
(7) Documentationメニューの［View Help File］を選択して、ヘルプを表示する

Sandcastle Help File Builderを利用すれば、難しいコマンドを入力することなくヘルプの生成と表示ができます。もし、Sandcastle Help File Builderが、内部的にどのようにSandcastleを呼び出しているのかを知りたい場合は、CleanIntermediatesプロパティをFalseに設定することで実行スクリプトを見ることができます。

また、Sandcastle Help File Builderは、GUIアプリケーションだけではなく、コンソールアプリケーション(C:\Program Files\EWSoftware\Sandcastle Help File Builder\SandcastleBuilderConsole.exe)も用意されています。SandcastleBuilderConsole.exeでは、(5)の手順で保存したSandcastle Help File Builderプロジェクト(*.shfb)を引数に実行できるため、コマンドプロンプトからも簡単に呼び出すことができます。

まとめ

以上、駆け足でしたがSandcastleによるヘルプファイルの生成の仕組みについて紹介してきました。Sandcastleは最初の環境構築に少し手間がかかりますが、一度構築してしまえば、運用はそれほど難しくありません。Sandcastleを導入すると、品質の高いリファレンスを生成することができますので、この機会に導入を検討してみてはいかがでしょうか。もし、うまく動かないなどのトラブルがあった場合には、どのようなコマンドでエラーがあったかをチェックすることで、解決の糸口が見つけられると思います。本稿がその一助になれば幸いです。

なお、Sandcastleは、Microsoftの.NET Frameworkのドキュメントの生成にも使われており、今後も定期的にバージョンアップされると思われます。Sandcastleに興味をもたれた方はSandcastleチームブログを購読して、最新情報をチェックしてみてはいかがでしょうか。