Generic Type Reference in XML Code Comment

Question

As I know, in an XML comment for a C # type or method, you can reference a generic type in a tag, for example:

///<see cref="name.space.typename&lt;T&rt;(paramtype)"> 

But I think there was another syntax that was less awkward? Something to get rid of these html entities '<'? I can’t find him right now. Can anyone help?

Answer 1

Here is a nice documentation article: C # XML documentation comments FAQ

The development team decided to improve this by allowing alternative syntax to refer to common types and methods in the document comments. In particular, instead of using open and closed angle brackets, it is permissible to use open and closed curly braces. The above example would become:

 class Program { /// <summary> /// DoSomething takes a <see cref="List{T}"/> /// </summary> void DoSomething(List<int> al) { } } 

So in your case:

 ///<see cref="name.space.typename{T}( paramtype )" /> 

Edit: the link above is broken; shows raw HTML. Leaving the link now. Here are some new links from Microsoft:

• Comments on XML Documentation (C # Programming Guide)
• Documenting your code with XML comments

Answer 2

Use curly braces:

 ///<see cref="name.space.typename{T}(paramtype)">