Sandcastleのインストール
Sandcastle Help File Builder より SHFBGuidedInstallerのzipファイルをダウンロード。
展開してインストーラを起動。
Nextボタンですすめる。途中、追加インストールを求められるので適当に。
環境によりMicrosoft Help 2 Compilerがインストールされていないとか警告が出るときあり。
使わなければ気にしない。
XMLドキュメントファイルを生成
APIリファレンス生成対象プロジェクトのXMLドキュメントファイルを生成する。
プロジェクトが含まれるソリューションを Visual Staudio 2010 で開く。
ソリューションエクスプローラーから対象プロジェクトを右クリックしプロパティを表示。
ビルドの設定で「XMLドキュメントファイル」をチェック。
ついでにAPIリファレンスに出したいブロジェクとがあれば同様にチェック。
逆にユニットテスト用のプロジェクトなど含めたく無いものはチェックしない。
メニューバーのビルドより「ソリューション」のビルドを実施。
ビルド完了後、「出力パス」にXMLファイルが存在することを確認。
Sandcastleプロジェクトを作成
プログラムよりSandcastle Help File Builder GUI を起動。
ツールバーのFileメニューよりNew Project を選択。
プロジェクトファイルの保存先を選択。
保存先にデスクトップとか選ぶとこのあとAPIリファレンスの生成でエラーになる場合あり。
プロジェクトの追加
Sandcastle Help File Builderウィンドウの右側にあるProject Explorer へ APIリファレンス生成対象のプロジェクトを追加。
Documentation Sources を右クリック。Add Documentation Sources をクリック。API生成対象のVisual Staudioプロジェクトファイルを選択する。
APIリファレンス生成対象のプロジェクトが複数ある場合は、同じ手順で。
Project Propertiesの設定
Sandcastle Help File BuilderウィンドウのProject Propertiesを設定する。お好みで。
- Build Properties
- Build these help file formats : 出力ファイルの形式。Website (HTML/ASP.NET)とか。
- Framework version: Visual Staudioプロジェクトで使用しているバージョンを指定。
- BuildAssemblerVerbosity: ビルド時に出力されるメッセージの種類。あんまりだしたく無ければOnly Errors を。
- Help File Properties
- Help title: Helpファイルのタイトル。
- Help file name: Help File の名前。
- Presentation Style: Help ファイルの見た目。
- Syntax Filter: AspNet, CSharp, JavaScriptとか
- Visibility Properties
- クラス中でAPIにだしたいスコープとかを選ぶ。だしすぎるとコメント不足でAPIに赤字が。
- Missing Tags Properties
- APIにだしたいコメントとかを選ぶ。だしすぎるとやっぱりコメント不足でAPIに赤字が。
APIリファレンスを生成
一通り設定したところで生成。
ツールバーのDocumentationよりBuild Project をクリック。
Build Output が表示され、出力処理の経過が表示される。エラーが発生しなければ3分程度で出力が完了。
エラーがでて出力出来ない場合、出力形式を確認。
インストール不足で出力出来ない形式を選んだ場合はエラーになる。
あと出力先のPathも確認。バージョンや環境によると思うがデスクトップだとエラーになった。
