Reference generic parameter in C# xml documentation comment

Question

How do I correctly reference the overloaded method with generic parameter in c# documentation comment? What should I put into cref attribute? I want Visual Studio 2010 (and ReSharper) to resolve it correctly.

/// <summary>
/// <see cref="MethodName(IEnumerable<string>)"/>
/// </summary>
public class ClassName
{

    public void MethodName(IEnumerable<string> param)
    {
        // code 
    }

    public void MethodName(string param)
    {
        // code 
    }
}

I did not find answer in this article (even though i could have missed it). https://msdn.microsoft.com/en-us/library/fsbx0t7x.aspx

cin · Accepted Answer · 2015-02-26 15:11:16Z

1

With CodingK0ala's link I finally were able to resolve it, even though I looked in the article before and did not find the answer then.

<see cref="MethodName(IEnumerable{string})"/>

Thanks.

EDIT: Actually I don't know what seemed so incomprehensible about it then. :)

answered Feb 26, 2015 at 15:11

cin

3513 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Reference generic parameter in C# xml documentation comment

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related