Sandcastle Help File Builder1.9を使ってヘルプを生成する

• 2013年追記
  • 2013年のSandcastle Help File Builderバージョン1.9.6/1.9.7時点では、下記サイトの情報が最新となっています。
    • Sandcastle(XMLコメントからAPIヘルプ生成)

C#やVB.NETでヘルプファイルを作成する手順メモです。Sandcastleが以前と少し変わったため、以下にまとめときます。

• インストールするもの
  • Sandcastle
    • XMLコメントを解析をする本体
  • Sandcastle 日本語メッセージ
    • APIドキュメントを日本語化したい場合に上書きコピー
  • Sandcastle Help File Builder
    • ヘルプ生成が簡単なGUIツール
  • HTML Help Workshop
    • HTML Help 1.x形式を出力する場合
    • すでにインストールさせていれば不要。HTML Help1.x形式を指定してエラーが出た場合に導入する
    • htmlhelp.exeをインストール
  • Visual Studio SDK
    • MSDNヘルプを出力する場合（個人的にはあまり使わない）
    • すでにインストールさせていれば不要。HTML Help2.x形式を指定してエラーが出た場合に導入する
    • 使用しているVSのバージョン（2005,2008,2010等）のSDKを選択

• Visual Studioプロジェクトの設定
  • プロジェクトのプロパティのビルドタブで、「XMLドキュメントファイル」にチェックボックスを入れる

• インストール後の手順
  1. ProjectExploreでDocumentationSourceを右クリックしてAPIドキュメントを生成するプロジェクトファイル（*.csproj等）を選択する
     • ProjectExploreが右ペインに表示されます
  2. FrameworkVersionプロパティで、.NET Frameworkのバージョンを選択する
  3. Languageプロパティで、「日本語 (日本)」を選択する
  4. HelpTypeFormatプロパティで、ヘルプの形式(1.x、2.x、MSHelpViewer、WebSite)を選択する
     • 以前のバージョンの３タイプに加えて、MSHelpViewerというVS2010形式のヘルプが増えていました。
  5. 必要があれば以下のプロパティも設定する
     1. HelpTitle/HTMLHtlpNameプロパティに名前を設定する
     2. SyntacsFilterで出力する言語（通常は１つ）を選択する
     3. PresentationStypeプロパティで、スタイル(hana,vs2005,prototype)を選択する
     4. APIFilterプロパティで、リンクしないクラスを選ぶ
  6. Fileメニューの［Save Project］で、プロジェクトを保存する(*.shfbproj形式）
     • MsBuildで処理できる形式に変更
  7. Documentationメニューの［Build Project］を選択して、ヘルプを生成する
  8. Documentationメニューの［View Help File］を選択して、ヘルプを表示する

• ビルドサーバーなど別サーバーで動してHelp File Builderが認識されない場合はパスを指定
  • MSBuild.exe /p:Configuration=Debug "/property:SHFBROOT=C:\Program Files\EWSoftware\Sandcastle Help File Builder" Test.shfbproj

• 参考
  • Sandcastleでヘルプを作ろう　〜Sandcastle Help File Builderで日本語のヘルプを作る
  • ヘルプの種類
  • Sandcastle Help File Builder が MSBuild に対応してた