Visual Basic コンパイラは、コード内のドキュメント コメントを XML ファイルに処理できます。 追加のツールを使用して、XML ファイルをドキュメントに処理できます。
XML コメントは、型や型メンバーなどのコードコンストラクトで使用できます。 部分型の場合、型の 1 つの部分だけが XML コメントを持つことができますが、そのメンバーのコメントに制限はありません。
注
ドキュメント コメントを名前空間に適用することはできません。 その理由は、1 つの名前空間が複数のアセンブリにまたがる可能性があり、すべてのアセンブリを同時に読み込む必要がないためです。
コンパイラは、有効な XML であるタグを処理します。 次のタグによって、ユーザー ドキュメントで一般的に使用される機能が与えられます。
- <c>
- <コード>
- <例>
- <exception>1
- <組み込み>1
- <リスト>
- <パラ>
- <param>1
- <paramref>
- <permission>1
- <備考>
- <収益>
- <see>1
- <seealso>1
- <概要>
- <typeparam>1
- <価値>
(1 コンパイラは構文を検証します。
注
ドキュメント コメントのテキストに山かっこを表示する場合は、 <
と >
を使用します。 たとえば、文字列 "<text in angle brackets>"
は <text in angle brackets>
として表示されます。
こちらも参照ください
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
.NET