Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

In xml doc, can I insert a reference to a method group? How?

In C#, I can attach documentation for properties, methods, events, and so on, directly in the code using XML Documentation Comments.

I know how to insert a reference to a particular method:

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

Is there a way to insert a reference to a method group? Where I've got multiple overloads of the same method name...

I tried

<see cref="M:MethodName"/>

..but that did not work.

EDIT: BUMP

like image 880
Cheeso Avatar asked Sep 11 '09 16:09

Cheeso


2 Answers

Apparently there is no way to do this.

like image 162
Cheeso Avatar answered Oct 24 '22 00:10

Cheeso


It appears that this was be fixed at least in Visual Studio 2012:

<see cref="MethodName"/>

Will generate a warning:

Ambiguous reference in cref attribute: 'MethodName'. Assuming '…', but could have also matched other overloads including '…'.

But adding an M: in front get's rid of the warning:

<see cref="M:MethodName"/>
like image 36
p.s.w.g Avatar answered Oct 23 '22 23:10

p.s.w.g