通过

建议用于文档注释的标记 (Visual C++)

  • 项目

Visual C++ 编译器将处理在代码的文档注释并创建每次编译的 .xdc 文件，并且，用于将处理 .xdc 文件添加到 .xml 文件。处理 .xml 文件创建文档需要在站点中实现的详细信息。

标记在结构化过程如类型和类型成员。

标记必须紧邻类型或成员。

说明说明

文档注释不能应用于命名空间或在属性和事件的不协调定义；文档注释在类的声明必须。

编译器将处理任何为有效 XML 的标记。下面的标记提供在用户文档的常用功能：

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>1

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<value>

 

 

1.编译器将验证语法。

在当前版本中，Visual C++ 编译器不支持 <paramref>，由其他 Visual Studio 编译器支持的标记。Visual C++ 支持在将来的版本 <paramref>。

请参见

其他资源

XML 文档 (Visual C++)