Adding line breaks to comments for Intellisense ...

Question

Does anyone know how to insert a line break into a summary comment in order for the line break to be reflected in Intellisense documentation?

To clarify, assume code documentation..

/// <summary>
/// Some text documentation
///  - a line break - 
/// Some more documentation
/// </summary>
public void SomeMethod() { }

So when using this method Intellisense offers a summary for the method formatted like this:

Some text documentation

Some more documentation

(Note - the 'para' tag doesn't create empty line breaks - I've tried it!)

Answer 1

Try using this.

/// <summary>
/// <para>Paragraph 1.</para>
/// <para>Paragraph 2.</para>
/// </summary>

But I don't think you can have an actual empty line. Empty para tag gets ignored.

Answer 2

Based on the comment, how about a with a single, non-printing character in it, like a hard space?

Answer 3

Well, it is Xml. Maybe 



Answer 4

Your only hope is probably something cludgy like this:

/// <summary>
/// <para>line one</para>
/// <para>_</para>
/// <para>line two</para>
/// </summary>

Answer 5

/// <summary>
/// <para>To treat comment line like a DIV tag, surround with PARA tags.</para>
/// <para>To add a break with whitespace, add the following:</para>
/// <para>&#160;</para>
/// </summary>

Answer 6

Does anyone know how to make it work in VB ?

(such a barbaric language, but I'm forced to work with it...)