CODEWITHSUNDEEP
c#.net
M. X
M. X

Reputation: 1347

XML in an XML Documentation Comment (C#)

How can I embed XML in an C# XML documentation comment (e.g. in an header of a method)?

Upvotes: 2

Views: 167

Answers (2)

to StackOverflow
to StackOverflow

Reputation: 124794

Put it in a CDATA section, and put the CDATA section inside a <code> element so it will be formatted correctly:

/// <example>
/// <code>
/// <![CDATA[ 
/// <someXml>
///     ...
/// </someXml>
/// ]]>
/// </code>
/// </example>

Upvotes: 9

Ozgur Dogus
Ozgur Dogus

Reputation: 921

Press '/' (slash) 3 times in the code file and it will open a code summary section. You can paste your xml on that section.

Upvotes: 0

Related Questions