コメントをXMLで書く

VB2005では、宣言の直前に「'」シングルコーテーションを3つ並べることでXMLコメントの雛形を 自動的に作成してくれます。

''' <summary>
''' 
''' </summary>
''' <remarks></remarks>

このXMLコメントからドキュメントを生成するために、NDocSandCastleといったツールも作成されています。 (SandCastle Blog)

※ NDocは、開発が停止しているようです。

XMLコメントを使用することで、コンパイル時にxmlファイルにコメントを出力してくれます。このコメントを 出力するように指定するには、[メニュー] - [プロジェクト] - [プロパティ]のコンパイルタブを選択し、 「XML ドキュメントファイルを生成する」にチェックをします。

XML ドキュメントファイルを生成する

上記雛形以外にもコメントとして使えるタグには主に次のものがあります。 (msdn:「ドキュメント コメントとして推奨される XML タグ」)

タグ 概要
<example>サンプルコードの説明
<list>リストまたは表を示す
<param>引数とその説明を示す
<remarks>説明を示す
<returns>戻り値とその説明を示す
<summary>概要を示す