Sandcastle Help File Builderでドキュメントを作成する

ライブラリ等のドキュメントを生成するのにSandcastleを使用したのですが、 このツールは、コマンドラインでコマンドをたたいて作成するツールでした。

このドキュメント生成をGUIで行うためのツールがSandcastle Help File Builderになります。

Sandcastle Help File Builder

Sandcastle Help File Builderのインストール

事前にSandcastleとHelp Workshopをインストールします。(Sandcastleのインストール参照)

Sandcastle Help File BuilderのホームページからSandcastleBuilderSetup.zipをダウンロードします。 ここでは、Sandcastle Help File Builder Version 1.5.0.1を対象としています。

SandcastleBuilderSetup.zipに含まれるSandcastleBuilderSetup.msiを実行しインストールを開始します。

「Sandcastle Help File Builderへようこそ」と表示されるので[Next]をクリックします。

Welcome to Sandcastle Help File Builder

Sandcastle Help File Builderのインストール先を指定します。

Sandcastle Help File Builderのインストール先

最終確認が行われ、インストールを実行します。

Sandcastle Help File Builderの使い方

Sandcastle Help File Builderを起動し、メニューから[Project] - [New Project from Visual Studio Project...]を 選択します。

New Project from Visual Studio Project...

どちらの構成(Debug又はRelease)を読み込むかと効かれるので、ドキュメントを作成したいほうを 選択します。

構成(Debug又はRelease)選択

ドキュメントを作成する対象となるアセンブリとXMLコメントファイルが表示されます。

対象ファイル

「Edit」ボタンをクリックしてXMLコメントのパスを確認します。(私の環境では、パスが間違っていました。)

アセンブリとXMLコメントファイルの設定

メニューから[Documentation] - [Build Project]を選択します。

Build Project

Sandcastle Help File Builderのプロジェクトファイルを保存する保存先を聞いてくるので、名前をつけて 保存します。

Sandcastleと同じように変換作業が行われ、Helpフォルダが作成されドキュメントが作成されます。