Summary comments in Class Library

  • Thread starter Thread starter Brian
  • Start date Start date
B

Brian

Hi,
I am trying to format my comments for my class library. how do i insert new
line feed so that all the text is not just jumbled in together
Brian
 
Generally, you don't worry about formatting within the XML comments as the
XML can be "styled" later. I'm not sure what "jumbled in together" means,
but the IDE will simply word wrap any comments that are too long for display
in intellisense.

-Scott
 
maybe so, but in the case where I am adding summary comments that will be
displayed in the object browser,,, all the lines run together, rather than
the way i have it displayed on the file....
I'd like to be force it to display a new line in the object browser for
example
''' <summary>

'''||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

'''||| Purpose: this is my purpose.|||

'''||| give a general description here |||

'''||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

''' </summary>

''' <remarks>blah, blah, remarks.</remarks>
 
I haven't tried it, but you could try embedding an HTML break command
(assuming the OB is displaying the XML using an HTML parser). Try adding
<br /> into the comments.
 
Back
Top