Referncing generic in XML comments

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

Paul S - 30 Oct 2007 11:04 GMT

Hi

A have a generic class - InfoCollection<T>

The code comment for my constructor is:
/// <summary>
/// Instantiates a new instances of the <see
cref="InfoCollection[T]"/> class.
/// </summary>

I get a warning in the compilation saying that the comment has syntactically
incorrect cref attribute.

How can I write my comment correctly. ?

Signature

Thanks
Paul S

Reply to this Message

Jon Skeet [C# MVP] - 30 Oct 2007 11:28 GMT

> A have a generic class - InfoCollection<T>
>
[quoted text clipped - 8 lines]
>
> How can I write my comment correctly. ?

Use braces instead of square brackets:

<see cref="InfoCollection{T}" />

(Intellisense may help if you hit Ctrl-Space after typing InfoCol - or
that could just be ReSharper on my box.)

Jon

Reply to this Message

Rate this thread:

Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...