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

Visual Basic コンパイラは、コード内のドキュメントコメントを XML ファイルに処理できます。The Visual Basic compiler can process documentation comments in your code to an XML file. XML ファイルをドキュメントに処理するために、追加のツールを使用できます。You can use additional tools to process the XML file into documentation.

XML コメントは、型や型のメンバーなどのコード構造で使用できます。XML comments are allowed on code constructs such as types and type members. 部分型の場合、XML コメントを持つことができるのは型の1つの部分のみですが、そのメンバーのコメントには制限はありません。For partial types, only one part of the type can have XML comments, although there is no restriction on commenting its members.

注意

ドキュメントコメントを名前空間に適用することはできません。Documentation comments cannot be applied to namespaces. これは、1つの名前空間が複数のアセンブリにまたがることができ、すべてのアセンブリを同時に読み込む必要がないためです。The reason is that one namespace can span several assemblies, and not all assemblies have to be loaded at the same time.

コンパイラは、有効な XML であるすべてのタグを処理します。The compiler processes any tag that is valid XML. 次のタグは、ユーザードキュメントで一般的に使用される機能を提供します。The following tags provide commonly used functionality in user documentation.

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

(1コンパイラは構文を検証します)。(1 The compiler verifies syntax.)

注意

ドキュメントコメントのテキストに山かっこを表示する場合は、&lt;&gt;を使用します。If you want angle brackets to appear in the text of a documentation comment, use &lt; and &gt;. たとえば、文字列 "&lt;text in angle brackets&gt;"<text in angle brackets>として表示されます。For example, the string "&lt;text in angle brackets&gt;" will appear as <text in angle brackets>.

関連項目See also