Locked History Actions

Diff for "CS"

Differences between revisions 6 and 7
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
== JavaDoc ==

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

C#ではJavaDoc相当のドキュメントを作成するには、以下の手順を踏む。

=== 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について ===
 * [[CS/JavaDoc|JavaDoc風ドキュメントを作成する]]