通过

<seealso> 文档标记

  • 项目

使用 <seealso> 标记，可以指定想要在“另请参阅”部分中显示的文本。 使用 <see> 从文本内指定链接。

语法

/// <seealso cref="member"/>

参数

member
对可从当前编译环境调用的成员或字段的引用。 将名称括在单引号或双引号中。

编译器检查是否存在给定的码位元素，并将 member 解析为输出 XML 中的元素名称。 如果编译器没有找到 member，它会发出警告。

有关如何创建对泛型类型的 cref 引用的信息，请参阅 <see>。

备注

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

有关使用 <seealso> 的示例，请参阅 <summary>。

MSVC 编译器将尝试通过文档注释在一次处理中解析 cref 引用。 如果编译器使用 C++ 查找规则时找不到符号，它会将引用标记为未解析。

示例

在以下示例中，cref 中引用了未解析的符号。 对 A::Test 的 cref 的 XML 注释格式正确：<seealso cref="M:A.Test" />。 但是，对 B::Test 的 cref 变为 <seealso cref="!:B::Test" />。

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

/// Text for class A.
public ref struct A {
   /// <summary><seealso cref="A::Test"/>
   /// <seealso cref="B::Test"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void Test() {}
};

/// Text for class B.
public ref struct B {
   void Test() {}
};

另请参阅

XML 文档