using see cref with < > characters in XML Documentation?

c# .net xml-comments xml-documentation
Martin picture Martin · Jan 28, 2011 · Viewed 7.2k times · Source

Possible Duplicate:
How to reference generic classes and methods in xml documentation

i have been using the see cref tag and it works great but now i need to include a generic list of string[] in the see cref but the documentation doesn't correctly render.

    /// <returns>A <see cref="List<string[]>" /> that .......

I presume its something to do with the < and > and maybe []

Is this allowed, is there a work around?

Answer

Pavel Surmenok picture Pavel Surmenok · Jan 28, 2011 
/// <returns>A <see cref="List{T}" /> that</returns>

Related questions

Visual Studio - Summary Tag Comments - Optional Params

When specifying summary tag comments, is there a way with the <param> tag to note that a parameter is optional, ie. the client can supply a value or null, such as: <param name="Mime" optional="true">. …

Read More
XML comments for properties / accessors

Is it possible to add XML comments for set and get accessors which will be visible in Object Browser (VS 2010)? /// <summary> /// Something about property. /// </summary> public bool IsSomething { // get description get { return isSomething; } // set description set { // …

Read More
XmlDocument reading XML Document comment Issue

I am using XmlDocument to parse xml file, but it seems that XmlDocument is always reading xml comments as a xml nodes: My C# code XmlDocument xml = new XmlDocument(); xml.Load(filename); foreach (XmlNode node in xml.FirstChild.ChildNodes) { } Xml …

Read More