9

在 C# 中,我可以使用XML Documentation Comments直接在代码中附加属性、方法、事件等的文档。

我知道如何插入对特定方法的引用:

<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>

有没有办法插入对方法组的引用?我有多个相同方法名称的重载......

我试过了

<see cref="M:MethodName"/>

..但这没有用。

编辑:凹凸

4

3 回答 3

2

显然没有办法做到这一点。

于 2009-10-10T17:43:06.000 回答
1

看来这至少在 Visual Studio 2012 中已得到修复:

<see cref="MethodName"/>

会产生警告:

cref 属性中的不明确引用:“MethodName”。假设“...”,但也可以匹配其他重载,包括“...”。

但是M:在前面添加一个可以消除警告:

<see cref="M:MethodName"/>
于 2013-08-12T17:35:13.590 回答
0

Sandcastle 现在支持此功能。

要引用方法组,需要以下语法:

/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }

请注意,此语法仍然有一些限制,如C# 语言功能请求所述。

  • 在构建期间不验证语法。直到 Sandcastle 帮助文件生成器处理评论时,才会报告键入时发生的错误。
  • 仅当有多个同名方法时,该语法才有效。
  • 此语法没有语法突出显示或编辑器支持。
于 2018-07-06T14:30:57.247 回答