Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Adding line breaks to comments for Intellisense [duplicate]

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!)

like image 390
flesh Avatar asked Jan 21 '09 21:01

flesh


1 Answers

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.

like image 174
Brian Kim Avatar answered Nov 12 '22 08:11

Brian Kim