通过

<see>（C# 编程指南）

  • 项目
<see cref="member"/>

参数

  • cref = "member"
    对可以通过当前编译环境进行调用的成员或字段的引用。 编译器检查给定的代码元素是否存在，并将 member 传递给输出 XML 中的元素名称。应将 member 放在双引号 (" ") 中。

备注

<see> 标记使您得以从文本内指定链接。 使用 <seealso> 指示文本应该放在“另请参见”节中。 用 cref 特性创建指向代码元素的文档页内部超链接。

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

下面的示例演示一个摘要节中的一 <see> 标记。

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

有关如何使用 <see> 的示例，请参见 <summary>。

请参见

参考

建议的文档注释标记（C# 编程指南）

概念

C# 编程指南