C# と .NET Framework 4 を主にWindows Formのアプリケーション開発について

XMLドキュメントを生成するためプロジェクト設定の変更

1. MicroRssReaderのソリューションを開きます。
2. MicroRssReaderのプロジェクトプロパティを表示します。
3. 「ビルド」タブを選択します。
4. "出力"項目の「XML ドキュメント ファイル」にチェックを入れます。
5. リビルドします。

CHMを生成してみる

まず、SandcastleBlog内の説明に従ってヘルプを生成してみます。

1. コマンドプロンプトを開き、プロジェクトのbin¥Debugに移動します。

cd C:\Develop\RSSリーダを作る\RssReader\MicroRssReader\bin\Debug

2. 次に、MRefBuilderを実行します。

MRefBuilder MicroRssReader.exe /out:reflection.org

3. 変換を行います。

set prodtrans="C:\Program Files\Sandcastle\ProductionTransforms"
XslTransform %prodtrans%\AddOverloads.xsl reflection.org |
 XslTransform %prodtrans%\AddGuidFilenames.xsl /out:reflection.xml

4. マニフェストを生成します。

XslTransform %prodtrans%\ReflectionToManifest.xsl reflection.xml /out:manifest.xml

5. 次のようなバッチファイルを作成して保存しておきます。
ファイル名は copyOutput.batにします。

set sandcastle="C:\Program Files\Sandcastle"
if not exist Output mkdir Output
if not exist Output\html mkdir Output\html
if not exist Output\art mkdir Output\art
if not exist Output\scripts mkdir Output\scripts
if not exist Output\styles mkdir Output\styles
copy %sandcastle%\Presentation\art\* Output\art
copy %sandcastle%\Presentation\scripts\* Output\scripts
copy %sandcastle%\Presentation\styles\* Output\styles

6. バッチファイルを実行します。

copyOutput.bat

7. コンフィグレーションをコピーして編集。

copy "C:\Program Files\Sandcastle\Presentation\Configuration\sandcastle.config" .

コピーしたsandcastle.configをエディタで開き、次のように置換を行い保存します。
"..\.." → "C:\Program Files\Sandcastle"
"..\cpref_reflection" → "C:\Program Files\Sandcastle\Examples\Cpref_reflection"
"comments.xml" → "MicroRssReser.XML"

8. BuildAssembler を実行します。

BuildAssembler /config:sandcastle.config manifest.xml

9. HTMLヘルプのTOCを生成します。

XslTransform %prodtrans%\ReflectionToChmContents.xsl reflection.xml 
/arg:html=Output\html /out:test.hhc

10. test.hhc を Outputディレクトリに移動する

copy test.hhc Output

11. hhp を Outputディレクトリにコピーする

copy "C:\Program Files\Sandcastle\Presentation\Chm\test.hhp" Output

12. Chmを生成するために hhc (HTML Help 1.x Compiler)を実行します

cd Output
"C:\Program Files\HTML Help Workshop\hhc" test.hhp

13. Chmを表示

test.chm

興味がある人のために、生成されたCHMファイルをサンプルとして置いておきます。
Test.zipファイルをダウンロード

出力結果について

1. MSDNの形式とも異なるため、見慣れない感があります
2. 日本語も正しく表示され、特に化けている所などもありません。
3. ///で書いているコメントも表示されていますが、任意改行が無視されています。
4. 単に継承しているメンバを消せるのは良いですね。
5. ジェネリックも正しくドキュメント出力されています。
6. メソッド パラメータの型等が自動的にリンクにならない。
7. フッタ（Copyrightの所）の変更方法が説明されていない。
8. 複数のDLLやEXEからドキュメントをマージ生成する方法が説明されていない
9. MSDNへのリンクが自動生成されない。
10. privateメンバをドキュメントに出力する方法が分からない

Sandcastle CTP版の印象

とりあえず、どのようなドキュメントが生成されるかは分かります。　ドキュメントの精度についてはほとんど問題ないと思います。
これでNDocレベルのカスタマイズが出来るようになれば十分NDocに取って代わることが出来ると思います。

出力までの手順は面倒であるが、正式版ではもっと楽になると期待しています。