2010年6月3日木曜日

.NET Sandcastleを使用してXMLコメントからヘルプを作成する。

Sandcastleを使用してXMLコメントからヘルプを作成する方法です。


まず必要なツールをダウンロードしインストールします。
Sandcastle Ver 2.4.10520よりSandcastle.msiをダウンロードし、インストールします。
HTML Help Workshop and Documentation Ver 1.32よりhtmlhelp.exeをダウンロードし、インストールします。
Sandcastle Help File Builder Ver 1.8.0.3をダウンロードし、インストールします。


すべてのプログラムより「Sandcastle Help File Builder」→「Sandcastle Help File Builder GUI」選択してSandcastle Help File Builder起動します。

「File」メニューの「New Project」を選択します。
ファイル保存ダイアログが表示されますので、ヘルププロジェクト名をつけて保存ボタンをクリックします。
※パスに日本語が含まれるとビルド時にエラーになってしまうようです。


「Porject Explorer」の「Documentation Sources」を右クリックし「Add Documentation Source…」をクリックします。
ファイル選択ダイアログが表示されますので、ヘルプファイルを作成したいソリューションやプロジェクト、exe、dllなどを選択します。

「Project Properties」の
「Help File」セクションの「Language」を日本語(日本)にします。
「Help File」セクションの「HtmlHelpName」にビルドすると作成されるヘルプファイル(chm)名を入力します。
「Visibility」セクションの「DocumentInheritedFrameworkMembers」Frameworkのクラスから継承したメンバを出力しない場合はFalseを設定します。
「Comments」セクションの「NamespaceSummaries」名前空間の説明を設定します。


「Documentation」メニューの「Build Project」を選択するとビルドが始まります。
ビルドが終了すると、ヘルププロジェクトフォルダの下に「Help」フォルダが作成され、そこに「HtmlHelpName」で指定したchmファイルが作成されます。

0 件のコメント: