建议的用于文档注释的 XML 标记 (Visual Basic)
Visual Basic 编译器可以将代码中的文档注释处理为 XML 文件。 你可以使用其他工具将 XML 文件处理为文档。
某些代码结构(例如类型和类型成员)上允许使用 XML 注释。 对于分部类型,只有一部分类型可以有 XML 注释,尽管对其成员的注释没有限制。
注意
不可对命名空间应用文档注释。 原因是一个命名空间可以跨越多个程序集,而不是必须同时加载所有程序集。
编译器可处理任何标记,前提是标记是有效的 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>
。