Geek Answers Handbook

In an XML document, can I insert a link to a group of methods? How?

In C #, I can attach documentation to properties, methods, events, etc. directly in code using XML Documentation Comments .

I know how to insert a link to a specific method:

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

Is there a way to insert a link to a group of methods? Where I have several overloads of one method name ...

I tried

 <see cref="M:MethodName"/>

.. but that didn't work.

EDIT: BUMP

+7
c # documentation documentation-generation
source share
2 answers

There seems to be no way to do this.

+2
source share

It looks like this has been fixed, at least in Visual Studio 2012:

 <see cref="MethodName"/>

Generates a warning:

Ambiguous reference in cref: 'MethodName' attribute. Assuming "& hellip;" but may also correspond to other overloads, including & quot; hellip; ".

But adding M: ahead eliminates the warning:

 <see cref="M:MethodName"/>
+1
source share

More articles:


All Articles