Visual studio XML comment for generics

Question

How can I write this in a proper way:

/// <summary>
/// Provides extension methods for <see cref="System.Collections.Generic.Dictionary"/> matrix.
/// </summary>
public static class DictonaryMatExtensions
{...}

System.Collections.Generic.Dictionary part is bothering me.

I want to build a documentation, and VS complaints that the System.Collections.Generic.Dictionary ca not be resolved. — dajuric
– dajuric, Commented Jul 6, 2014 at 14:56
OK, what is the proper way to write System.Collections.Generic.Dictionary so the compiler does not complain ? — dajuric
– dajuric, Commented Jul 6, 2014 at 15:07
You are correct, this is a problem because for example with a class Foo<T> my compiler produces warning CS1574: XML comment on ... has cref attribute 'Foo' that could not be resolved. Is this same same warning # you get? — John Alexiou
– John Alexiou, Commented Jul 6, 2014 at 15:10

keyboardP · Accepted Answer · 2014-07-06 15:18:42Z

4

Try using { and } to represent the generic parameter(s)

/// ... <see cref="System.Collections.Generic.Dictionary{TKey, TValue}"/> matrix.

answered Jul 6, 2014 at 15:18

keyboardP

69.5k13 gold badges162 silver badges209 bronze badges

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

Collectives™ on Stack Overflow

Visual studio XML comment for generics

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