面倒くさいドキュメント作成を自動化してくれるツール NDoc の使い方メモ。

NDoc は、Visual Studio が生成するXMLドキュメントから、MSDN風のドキュメント(HTMLおよびヘルプファイル)を自動生成してくれるフリーのツール。

セットアップ

●インストール
Ndoc日本語版のインストーラをダウンロード、インストールする。
http://sourceforge.jp/projects/ndoc-jp/
ndoc-jp-installer がインストーラ
●.NET2.0対応の細工
NDocは .NET2.0には未対応なので、小細工をする。
下記テキストを NDocGui.exe.config という名前で保存し、NDocGui.exe と同じフォルダ（Ndocのインストールフォルダの下のbinフォルダ）に置く。



<?xml version="1.0" ?>

<configuration>

<startup>

<supportedRuntime version="v2.0.50727" />

<supportedRuntime version="v1.1.4322" />

<requiredRuntime version="v1.1.4322" />

</startup>

</configuration>

XMLドキュメントの生成

●XMLコメントを書く (基本)
Visual Studio 2005 の C# の場合、クラスやメソッド、プロパティなどの前の行で /// と入力すると、勝手にXMLコメントのひな型ができる。ここに<summary>タグに要約、<param>タグに引数、<returns>タグに戻り値のコメントを書き込む。
●XMLコメントを書く (その他)
解説･･･ <remarks>タグで書く。HTML同様のタグが使える。改行には<br />タグが必要。
オーバーロード･･･ 1個目の定義のXMLコメントで<overloads>タグで全体の要約を書く。
例外･･･ <exception cref="例外クラス名を名前空間から">タグで条件を書く。
●ビルド
プロジェクトの[プロパティ]の[ビルド]で[XMLドキュメントファイル]を出力するよう設定。
ビルドすると、dll/exeといっしょにXMLドキュメントも生成される。

NDocでドキュメントを生成

●NDocの設定
[Add] でビルドされたdll/exeとXMLドキュメントを指定する。
[Namespace Summaries] で名前空間の説明を書く。
[Documentation Type] でドキュメントのフォーマットを選ぶ。とりあえずMSDNで。
[HtmlHelpName] でヘルプファイルの名前を指定。
[OutputDirectory] でドキュメントの出力先を指定。
[OutputTarget] で HTMLのみ出力/ヘルプファイルのみ出力/両方出力を選択。
[SdkDocLanguage] で Japanese を選択。
[Title] でドキュメントのタイトルを指定。
[DocumentInheritedFrameworkMembers] をFalseに。
　　( .NETライブラリの基本クラスから継承したメンバは書かない )
[DocumentPrivates] privateのメンバについて書くかはお好みで。( デフォルトではFalse )
とりあえずこんなもんでセーブしておく。
●ビルド
ビルドを実行するとドキュメントが生成される。

これはらくちんで (・∀・)イイ！

【参考】
http://www.atmarkit.co.jp/fdotnet/dotnettips/185ndoc/ndoc.html
http://ndoc-jp.sourceforge.jp/
http://ndoc.sourceforge.net/