C# xml documentation error

Question

I am trying to add documentation to my C# code. But the following gives me a malformed xml error. I know that the error is because of 'List"Display"'. It's trying to find "/Display". But there won't be a "/Display" because it's a part of my code example. Can someone help me with this? Thank you.

    /// <summary>
    ///   Retrieves a list of <c>Display</c>
    /// </summary>
    /// <example>
    ///   <code>
    ///     List<Display> templates = DisplayManager.GetDisplays();
    ///   </code>
    /// </example>

D Stanley · Accepted Answer · 2013-04-11 18:11:22Z

3

Wrap your code in a CDATA block:

///   <code>
///     <![CDATA[
///     List<Display> templates = DisplayManager.GetDisplays();
///     ]]>
///   </code>

or encode the angle brackets:

///   <code>
///     List&lt;Display&gt; templates = DisplayManager.GetDisplays();
///   </code>

answered Apr 11, 2013 at 18:11

D Stanley

153k12 gold badges189 silver badges257 bronze badges

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

Comments

Fredrik Mörk · Accepted Answer · 2013-04-11 18:13:27Z

2

It's quite common to write List{Display} in XML documentation.

answered Apr 11, 2013 at 18:13

Fredrik Mörk

159k31 gold badges296 silver badges349 bronze badges

Comments

pollirrata · Accepted Answer · 2013-04-11 18:11:33Z

1

Try wrapping yout code content within CDATA

<![CDATA[List<Display> templates = DisplayManager.GetDisplays();]]>

All text in an XML document will be parsed by the parser.

But text inside a CDATA section will be ignored by the parser.

answered Apr 11, 2013 at 18:11

pollirrata

5,2942 gold badges35 silver badges51 bronze badges

Collectives™ on Stack Overflow

C# xml documentation error

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related