= JavaDoc風ドキュメント =

C#でJavaDoc風のドキュメントを生成したい、つまり、プログラムソースコードにつけたコメントを拾い集め、それを適当にhtml化して閲覧したい。

以下のいずれの方法でも（おそらく）C#のコメントとして「///」から始まるコメントを記述し、それをドキュメント化する。

=== Visual C#での設定 ===

 * ソースコードに「///」で開始するXMLのコメントをつける。
 * Visual C#のプロジェクトプロパティの「ビルド」タブで、XMLドキュメントファイルにチェックを入れ、出力ファイル名を指定する。
 * ビルドする。

これでソースから抜き出されたxmlファイルが生成されるが、そのままではドキュメントにならない。

=== Sandcastleのインストールと使い方 ===

※2012/8/8現在、この方法は使えない。

C#用の処理系としてNDocがあるが、現在のバージョンには対応していない。
ここではSandcastle使うことにする。以下からSanscastle Help File Builderをダウンロードし、Zipを解凍して中の
SandcastleInstaller.exeを実行する。

 * http://shfb.codeplex.com/

実行途中でHtml Help 1 Compiler（.chm生成）をインストールしなければならなくなるが、このありかがリンク切れ（2012/8/8現在）で使えない。


Sandcastle自体の使いかたは以下を参考にする。


 * http://d.hatena.ne.jp/abcneet/20110604/1307166476

=== NDocについて ===

NDocはVisual C# 2010には対応しておらず、使えない。

=== Doxygenについて ===

Doxygenの場合、C#のソースコードを直接解析してしまうらしいので、xmlファイルの出力は不要。
以下を参考にする。

 * [[http://blacky11.blog79.fc2.com/blog-entry-9.html]]

要するに以下の手順。

 * Graphviz、Doxygenをインストールし、
 * Doxygenを実行し、一時領域フォルダ、対象ソースフォルダ、出力htmlフォルダやオプションを指定して実行する。
 * htmlが生成される。
 * 設定をDoxyfileにセーブできるので、次回からはそれを指定すればよい。

Visual C#にDoxyfileを指定し、ビルドの最後に自動的に実行させることもできる模様。

=== A HotDocument ===

有料製品。４万円ほどする。

 * [[http://www.hotdocument.net/]]

== 参考 ==

 * http://dobon.net/vb/dotnet/vs/commentwebreport.html