Question

在这个特定的代码示例中，我想引用C# documentation标记中的第二个重载方法（int n）：

/// <summary>
/// The method to pass an integer to is <see cref="DoSomething">
/// </summary>

void DoSomething() {
}
void DoSomething(int n)  {
}
void DoSomething(string str) { 
}

但是怎么样？

Answer 1

当ReSharper帮助我完成cref属性时，它包含有重载时的参数类型（即DoSomething(int)）。我假设这是有效的方法。

Answer 2

当Visual Studio生成包含关联程序集注释的XML文档文件时，每个文档化成员将由唯一名称标识。您可以在以下位置检查此ID生成的规则：

Processing the XML File (C# Programming Guide)

特别感兴趣的是具有基本类型参数的方法的规则，即：

对于属性和方法，如果有的话   是方法的参数，   括在括号中的参数列表   如下。如果没有参数，不   括号存在。争论   用逗号分隔。编码   每个论点直接跟随如何   它在.NET Framework中编码   签名：


基本类型。常规类型（ELEMENT_TYPE_CLASS或   ELEMENT_TYPE_VALUETYPE）是   代表完全合格   类型的名称。

...

在您的情况下会产生ID（M:YourNamespace.YourType.DoSomething(System.Int32)），然后可以在cref属性中使用。

我可以使用C＃文档标记引用重载方法吗？

2 个答案: