Line breaks in Comments

  • Thread starter Thread starter Etienne-Louis Nicolet
  • Start date Start date
E

Etienne-Louis Nicolet

Typing three single quotes enables me to comment entities within my code.
These are visible in the Object Browser. How can I put line breaks in the
comments in order to make them more readable?

E.g.
''' <summary>
''' My Summary Line 1
''' My Summary Line 2
''' </summary>
''' ...

will appear as

"My Summary Line 1My Summary Line 2"

in the Object Browser

Thanks for your help,
Etienne
 
Hi Etienne,

Unfortunately I don't think there is. You could try editing the emitted xml
file, but I think this might be more to do with how object browser reads
those files.
 
file, but I think this might be more to do with how object browser reads

Exactly. There is standard <para> tag (see http://tinyurl.com/5nfj88)
which is used for this purpose. But VS seems to strip all XML formatting
tags from <summary> and <remarks> sections. So neither Object browser
nor IntelliSense show new line. However, I recommend to use <para> tags
because they are used if you generate complete MSDN documentation for
your project using one of tools available, e.g. our VSdocman.
 
Back
Top