コメントをXMLで書く

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

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

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

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

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

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