在 C# 中,我可以使用XML Documentation Comments直接在代码中附加属性、方法、事件等的文档。
我知道如何插入对特定方法的引用:
<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>
有没有办法插入对方法组的引用?我有多个相同方法名称的重载......
我试过了
<see cref="M:MethodName"/>
..但这没有用。
编辑:凹凸
在 C# 中,我可以使用XML Documentation Comments直接在代码中附加属性、方法、事件等的文档。
我知道如何插入对特定方法的引用:
<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>
有没有办法插入对方法组的引用?我有多个相同方法名称的重载......
我试过了
<see cref="M:MethodName"/>
..但这没有用。
编辑:凹凸
显然没有办法做到这一点。
看来这至少在 Visual Studio 2012 中已得到修复:
<see cref="MethodName"/>
会产生警告:
cref 属性中的不明确引用:“MethodName”。假设“...”,但也可以匹配其他重载,包括“...”。
但是M:
在前面添加一个可以消除警告:
<see cref="M:MethodName"/>
要引用方法组,需要以下语法:
/// <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# 语言功能请求所述。