Summary comments in Class Library

Summary comments in Class Library

am 13.04.2008 00:21:38 von Brian Shafer

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

Re: Summary comments in Class Library

am 13.04.2008 01:37:59 von smar

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" wrote in message
news:OCSuUuOnIHA.1204@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
>

Re: Summary comments in Class Library

am 13.04.2008 02:43:12 von Brian Shafer

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
'''



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

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

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

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

'''


''' blah, blah, remarks.

"Scott M." wrote in message
news:eYGcpXPnIHA.5160@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" wrote in message
> news:OCSuUuOnIHA.1204@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
>>
>
>

Re: Summary comments in Class Library

am 13.04.2008 03:45:14 von smar

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

into the comments.


"Brian" wrote in message
news:%23TpYc9PnIHA.3780@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
> '''


>
> '''||||||||||||||||||||||||||||||||||||||||||||||||||||||||| |||||||||||||||||
>
> '''||| Purpose: this is my purpose.|||
>
> '''||| give a general description here |||
>
> '''||||||||||||||||||||||||||||||||||||||||||||||||||||||||| |||||||||||||||||
>
> '''

>
> ''' blah, blah, remarks.
>
> "Scott M." wrote in message
> news:eYGcpXPnIHA.5160@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" wrote in message
>> news:OCSuUuOnIHA.1204@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
>>>
>>
>>
>
>