ドキュメント コメントとして推奨される XML タグ (Visual Basic)

更新 : 2007 年 11 月

Visual Basic コンパイラは、コード中のドキュメント コメントを処理して XML ファイルを生成できます。専用のツールを使用すると、この XML ファイルからドキュメントを生成できます。

XML コメントは、型や型メンバなどのコードの構成体に対して使用できます。partial 型の場合は、型の 1 部分にのみ XML コメントを使用できます。ただし、部分型のメンバのコメント作成に対する制限は何もありません。

メモ :
ドキュメント コメントは名前空間には使用できません。その理由は、1 つの名前空間に複数のアセンブリが属し、すべてのアセンブリが同時にロードされるとは限らないからです。

コンパイラは、有効な XML のタグをすべて処理します。ユーザー ドキュメントで一般的に使用される機能を提供するタグを次の表に示します。

<c>	<code>	<example>
<exception>1	<include>1	<list>
<para>	<param>1	<paramref>
<permission>1	<remarks>	<returns>
<see>1	<seealso>1	<summary>
<typeparam>1	<value>

(1 コンパイラが構文を検証します。)

メモ :
ドキュメント コメントのテキストに山かっこを出力するには、&lt; と &gt; を使用します。たとえば、文字列 "&lt;text in angle brackets&gt;" は、<text in anglebrackets> と出力されます。

参照

処理手順

方法 : Visual Basic で XML ドキュメントを作成する

概念

XML の使用によるコードのドキュメントの作成 (Visual Basic)

参照

/doc