通过

<remarks> 文档标记

  • 项目

<remarks> 标记用于添加有关某个类型的信息，从而补充由 <summary> 指定的信息。 此信息显示在对象浏览器和代码注释 Web 报表中。

语法

/// <remarks>description</remarks>

参数

description
对成员的说明。

备注

使用 /doc 进行编译可以将文档注释处理到文件中。

示例

// xml_remarks_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_remarks_tag.dll

using namespace System;

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public ref class MyClass {};

另请参阅

XML 文档