473,466 Members | 1,503 Online
Bytes | Software Development & Data Engineering Community
Create Post

Home Posts Topics Members FAQ

Summary comments in Class Library

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
Jun 27 '08 #1
3 1322
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

"Brian" <bs********@community.nospamwrote in message
news:OC**************@TK2MSFTNGP03.phx.gbl...
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

Jun 27 '08 #2
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>

"Scott M." <sm**@nospam.nospamwrote in message
news:eY**************@TK2MSFTNGP05.phx.gbl...
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

"Brian" <bs********@community.nospamwrote in message
news:OC**************@TK2MSFTNGP03.phx.gbl...
>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


Jun 27 '08 #3
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.
"Brian" <bs********@community.nospamwrote in message
news:%2****************@TK2MSFTNGP06.phx.gbl...
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>

"Scott M." <sm**@nospam.nospamwrote in message
news:eY**************@TK2MSFTNGP05.phx.gbl...
>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

"Brian" <bs********@community.nospamwrote in message
news:OC**************@TK2MSFTNGP03.phx.gbl...
>>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



Jun 27 '08 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new...
0
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The...
0
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.