ドキュメント コメントとして推奨される XML タグ (Visual Basic)
Visual Basic コンパイラでは、コード内のドキュメント コメントを処理し、XML ファイルに変換できます。 追加のツールを利用すれば、XML ファイルを処理してドキュメントに変換できます。
XML コメントは、型や型メンバーなどのコード コンストラクターで許可されます。 部分型の場合、そのメンバーに対するコメント作成に制限はありませんが、XML コメントを追加できる型の部分は 1 つだけです。
注意
ドキュメント コメントは、名前空間に適用できません。 その理由は、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 コンパイラによって構文が検証されます。)
注意
ドキュメント コメントのテキストに山かっこを表示する場合は、< と > を使用します。 たとえば、文字列 "<text in angle brackets>" は <text in angle brackets> として表示されます。