XML Document

XML Document (C# によるプログラミング入門)
http://ufcpp.net/study/csharp/sp_xmldoc.html
概要、XML Documentの例、Documentation Comment


ライブラリのドキュメントを書く作業を楽にするために、コンパイラは自動でXML形式のドキュメントを生成してくれる。
C#は、javadocに似た機能を標準で持っている。標準なのでコンパイラのチェックがかかるし、Visual Studioの支援を受けられる。
コンパイル時に/docオプションを指定する。

csc /out:DocumentTest.dll /target:library doctest.cs /doc:doctest.xml


クラスやメソッドの前にドキュメンテーションコメント(///で始まるコメントや、/** ... **/という形のコメント)を入れておくと、
そのクラスやメソッドに関する説明をXMLファイルに書き出してくれる。
ドキュメンテーションコメントは、専用のタグを使って書く。