Cleanly adding line breaks to XML comments in Visual Studio

Question

Is there any way to add a break to XML documentation without using a <br> tag? In the below example, I want the text in the steps node to be cleanly displayed in the output. Example, line breaks are present in the output:

///<summary> this is a unit test </summary>
///<steps>
/// 1. do something
/// 2. do something else
/// 3. save that something
///</steps>

If I use a <br> tag the tag will be displayed if I open the XML file in IE. At least for now I want to avoid using something like Sandcastle as I have very minimal display needs.

Thank you for your suggestion. I gave CDATA a try but it did not solve the problem. — hhcib
– hhcib, Commented Aug 26, 2013 at 19:46

Abel · Accepted Answer · 2016-09-19 20:28:23Z

2

try

///<para>1. Do Something</para>

And

///<para/>1. Do Something

might also work, for 1-liners anyway.

Now if you want a list…

///<list>
///<item>Do Something</item>
///<item/>Experiment to see if this works
///</list>

Here is a nice, concise article on XML comment tags .

edited Sep 19, 2016 at 20:28

Abel

57.5k25 gold badges159 silver badges260 bronze badges

answered Jan 24, 2014 at 22:14

radarbob

5,1212 gold badges26 silver badges39 bronze badges

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

Collectives™ on Stack Overflow

Cleanly adding line breaks to XML comments in Visual Studio

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