Question about comment format.

[news.microsoft.net]

When I wrote <summary> comment for a function. I wrote:
/// <summary>
/// Line one.
/// Line two.
/// </summary>
I want the intelligence mechanism display:
Line one.
Line Two.
but it display:
Line one. Line two.
They were put in one line. How could I get what I want? Thank you.

[Peter Koen]

"news.microsoft.net" <Wi*********@hotmail.com> wrote in news:
#h*************@TK2MSFTNGP11.phx.gbl:

When I wrote <summary> comment for a function. I wrote:
/// <summary>
/// Line one.
/// Line two.
/// </summary>
I want the intelligence mechanism display:
Line one.
Line Two.
but it display:
Line one. Line two.
They were put in one line. How could I get what I want? Thank you.

I'm not sure about this, but you could try to include Escape Sequenzes (\n
\r\t,...) or maybe encoded HTML Tags (&lt;br&gt;... ).

Depends on what MS used for rendering the intellisense

--
------ooo---OOO---ooo------

Peter Koen - www.kema.at
MCAD CAI/RS CASE/RS IAT

------ooo---OOO---ooo------

[Jon Skeet [C# MVP]]

news.microsoft.net <Wi*********@hotmail.com> wrote:

When I wrote <summary> comment for a function. I wrote:
/// <summary>
/// Line one.
/// Line two.
/// </summary>
I want the intelligence mechanism display:
Line one.
Line Two.
but it display:
Line one. Line two.
They were put in one line. How could I get what I want? Thank you.

You can break them into paragraphs using:

/// <summary>
/// <para>Paragraph 1</para>
/// <para>Paragraph 2</para>
/// <summary>

Or you could use <list> if that's more appropriate.

See "XML documentation, tags for comments" in MSDN for more
information.

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

[news.microsoft.net]

I have tried <para>, <p>, <list> and even <br> and \r \n.
They do not take any effect. (<list> inserts some white space but does not
insert CRLF)
It seems that vs.net does not know their meanings.
What can I do then?
Thank you.
"news.microsoft.net" <Wi*********@hotmail.com> дÈëÓʼþ
news:%2***************@TK2MSFTNGP11.phx.gbl...

When I wrote <summary> comment for a function. I wrote:
/// <summary>
/// Line one.
/// Line two.
/// </summary>
I want the intelligence mechanism display:
Line one.
Line Two.
but it display:
Line one. Line two.
They were put in one line. How could I get what I want? Thank you.

[Jon Skeet [C# MVP]]

news.microsoft.net <Wi*********@hotmail.com> wrote:

I have tried <para>, <p>, <list> and even <br> and \r \n.
They do not take any effect. (<list> inserts some white space but does not
insert CRLF) It seems that vs.net does not know their meanings.
What can I do then?

Where are you looking for the effects? Are you building the
documentation with NDoc, or just looking at what VS.NET shows in
tooltips?

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

[Daniel O'Connell]

I suspect that the IDE attempts to keep your summaries compact so that
intellisense windows do not grow to large. Documentation generators should
get the output right, but VS doesn't appear to do this properly Ideally you
would want the summary tag to be rather short, with more complex comments in
the <remarks> tag.
"news.microsoft.net" <Wi*********@hotmail.com> wrote in message
news:ur**************@TK2MSFTNGP09.phx.gbl...

I have tried <para>, <p>, <list> and even <br> and \r \n.
They do not take any effect. (<list> inserts some white space but does not
insert CRLF)
It seems that vs.net does not know their meanings.
What can I do then?
Thank you.
"news.microsoft.net" <Wi*********@hotmail.com> $BP4HkSJ<~(B
news:%2***************@TK2MSFTNGP11.phx.gbl...

When I wrote <summary> comment for a function. I wrote:
/// <summary>
/// Line one.
/// Line two.
/// </summary>
I want the intelligence mechanism display:
Line one.
Line Two.
but it display:
Line one. Line two.
They were put in one line. How could I get what I want? Thank you.

[Alan Pretre]

"news.microsoft.net" <Wi*********@hotmail.com> wrote in message
news:ur**************@TK2MSFTNGP09.phx.gbl...

I have tried <para>, <p>, <list> and even <br> and \r \n.
They do not take any effect. (<list> inserts some white space but does not
insert CRLF)
It seems that vs.net does not know their meanings.

I suspect you are using "Build Comments Web Pages". To achieve line and
paragraph breaks you will need to use the XML tag <newpara/> and the HTML
tag <br> in your comments. Unfortunately <br> is not well formed XML and VS
will complain abot it. So you will need to turn off the error CS1570 in
your project settings.

See:
http://msdn.microsoft.com/library/de...rrorsc1570.asp

-- Alan

[news.microsoft.net]

I just want vs.net tooltip text to be shown in this format:
This is a summary text.
This is another summary text.
"Jon Skeet [C# MVP]" <sk***@pobox.com> ????
news:MP************************@msnews.microsoft.c om...

news.microsoft.net <Wi*********@hotmail.com> wrote:

I have tried <para>, <p>, <list> and even <br> and \r \n.
They do not take any effect. (<list> inserts some white space but does not insert CRLF) It seems that vs.net does not know their meanings.
What can I do then?

Where are you looking for the effects? Are you building the
documentation with NDoc, or just looking at what VS.NET shows in
tooltips?

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

[keyur shah]

Pls use escape sequences... to fulfill ur need.

Keyur Shah
*** Sent via Developersdex http://www.developersdex.com ***
Don't just participate in USENET...get rewarded for it!

[Kerry Sanders]

>You can break them into paragraphs using:

/// <summary>
/// <para>Paragraph 1</para>
/// <para>Paragraph 2</para>
/// <summary>

Or you could use <list> if that's more appropriate.

See "XML documentation, tags for comments" in MSDN for more
information.

Yea... this still does not work with Intellisense, however, Jon. It works great
with NDoc, but if you are using the object browser or intellisense, it displays
anything in the <para></para> tags as one long run-on sentence from the
<summary></summary> tags.

[Jon Skeet [C# MVP]]

Kerry Sanders <di****@NOSPAMyahoo.com> wrote:

You can break them into paragraphs using:

/// <summary>
/// <para>Paragraph 1</para>
/// <para>Paragraph 2</para>
/// <summary>

Or you could use <list> if that's more appropriate.

See "XML documentation, tags for comments" in MSDN for more
information.

Yea... this still does not work with Intellisense, however, Jon. It works great
with NDoc, but if you are using the object browser or intellisense, it displays
anything in the <para></para> tags as one long run-on sentence from the
<summary></summary> tags.

Unfortunately this sounds like a limitation in VS.NET then :(

--
Jon Skeet - <sk***@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

[Kerry Sanders]

On Wed, 19 Nov 2003 11:49:08 -0000, Jon Skeet [C# MVP] <sk***@pobox.com> wrote:

Yea... this still does not work with Intellisense, however, Jon. It works great
with NDoc, but if you are using the object browser or intellisense, it displays
anything in the <para></para> tags as one long run-on sentence from the
<summary></summary> tags.

Unfortunately this sounds like a limitation in VS.NET then :(

Yes. The option to create documentation web pages is severely broken, IMHO. It
runs everything together in one long sentence. It does not handle any of the
tags such as <para> or <remarks>.

I found NDoc and never looked back. It is very cool. Now if I could just
figure out how to use the Visual Studio Help Integration tool and integrate my
help file into the IDE. :)