代码之家 › 专栏 › 技术社区 › John K

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

comments xml c#

2

John K · 技术社区 · 15 年前

在这个特定的代码示例中,我想引用 C# documentation 标签:

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

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

但是如何呢?

2 回复 | 直到 15 年前

1

2

bdukes Jon Skeet 15 年前

当resharper帮我完成 cref 属性,当存在重载(即 DoSomething(int) )我想这是有效的方法。

2

João Angelo 15 年前

当visual studio生成包含关联程序集的注释的xml文档文件时,每个文档成员都将由一个唯一的名称标识。您可以在以下位置检查此ID生成的规则:

Processing the XML File (C# Programming Guide)

特别值得注意的是具有基类型参数的方法的规则,即:

对于属性和方法,如果有是方法的参数, 括号内的参数列表跟随。如果没有争论,就没有有括号。论据以逗号分隔。编码每一个论点的直接结果是它是在.NET框架中编码的签名:

基本类型。常规类型(元素类型或元素类型代表完全合格类型的名称。

…

在你的情况下会导致( M:YourNamespace.YourType.DoSomething(System.Int32) ,然后可用于 cref 属性。