Sandcastleを試してみました
ちょこちょこ詰まったけど、とりあえずHTMLヘルプファイルの生成までできました。
というわけで、C#のソースコードからAPIドキュメントを作成する方法のまとめです。
作成した環境はVisualStudio2005です。
まずSandcastleはCUIのツールなので、通常だとコマンドラインから操作する必要があります
あとはバッチファイル作ったりだとか、NAntから操作したりとかですね。
でも僕はとりあえず今のやつを簡単に出力したかったので、SandcastleのGUI操作ツールである、Sandcastle Help File Builderをつかいました。
ダウンロード
HTML Help WorkshopをMSのサイトからダウンロード
HTMLヘルプファイルを作成するのに必要なので、以下のリンクからダウンロードします
http://msdn2.microsoft.com/en-us/library/ms669985.aspx
ここから、Download Htmlhelp.exeのリンクをクリックすればOKです
SandcastleとSandcastle Help File BuilderをCodePlexからダウンロードする
今回使用したバージョンは
Sandcastle January 2008 Release(http://www.codeplex.com/Sandcastle/Release/ProjectReleases.aspx?ReleaseId=9921)*1
Sandcastle Help File Builder 1.6.0.4 Production(http://www.codeplex.com/SHFB/Release/ProjectReleases.aspx?ReleaseId=9848)
です。
インストール
SandcastleとHelp File Builderはインストーラがついてるので、そのままの設定でインストール
Help Workshopは、自己解凍形式なのでそのままデフォルトのパスに解凍します
これでインストールは完了です
ドキュメントを生成するための準備
プロジェクトの設定
プロジェクトを右クリック→プロパティ→ビルドタブ→出力の、XMLドキュメントファイルにチェックを入れます
ビルド
この状態でビルドすると、出力ファイルの隣に同じ名前のxmlファイルが出力されます。
HTMLヘルプファイルの出力
Sandcastle Help File Builderを起動する
右側にあるAddボタンを押して、dll,exe,xml何れかのファイルを追加します。dllを追加するとxmlも自動的に読み込まれるようです。
そして、このままだと日本語が表示できないので、言語のプロパティは変更しておきます
Help FileのLanguageを日本語(日本)に変更すればいいだけです。
あとはビルドボタンを押して終了
PathsのOutputPathに入力した場所にヘルプ形式のファイルが出力されます。
他にも色々できそうですが、とりあえず今日はここまでで終了。
誰か全部和訳してたりしませんかね。。。
