473,287 Members | 1,741 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,287 software developers and data experts.

Question about comment format.

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.
Nov 15 '05 #1
11 1662
"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------
Nov 15 '05 #2
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
Nov 15 '05 #3
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.

Nov 15 '05 #4
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
Nov 15 '05 #5
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.


Nov 15 '05 #6
"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
Nov 15 '05 #7
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

Nov 15 '05 #8
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!
Nov 15 '05 #9
>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.

Nov 15 '05 #10
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
Nov 15 '05 #11
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. :)

Nov 15 '05 #12

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

Similar topics

16
by: qwweeeit | last post by:
In analysing a very big application (pysol) made of almost 100 sources, I had the need to remove comments. Removing the comments which take all the line is straightforward... Instead for the...
3
by: jvax | last post by:
Hi all, I hope I'm posting in the right NG... I have a data text file I want to read from a c++ program. the data file goes like this: 90 # number of balls 33 42 13
9
by: Dave H | last post by:
Hello, I have a query regarding definition lists. Is it good practice semantically to use the dt and dd elements to mark up questions and answers in a frequently asked questions list, or FAQ? ...
2
by: gene.ellis | last post by:
Hello everyone. I have a pretty straight forward question: I have some data stored in an XMl document in the format of: <comment_info> <comments>These are the comments</comments>...
10
by: Vavel | last post by:
Hi all! I want to insert the record into the table by using an application program that includes the following statements: EXEC SQL BEGIN DECLARE SECTION; long hvInt_Stor; long hvExt_Stor;...
0
by: Natalia DeBow | last post by:
Hi there, I am stuck here on another problem, trying to come up with a regular expression for the following case: a. if a substring "/*" is detected, there is no "*/" that would follow it; b....
13
by: Eric_Dexter | last post by:
All I am after realy is to change this reline = re.line.split('instr', '/d$') into something that grabs any line with instr in it take all the numbers and then grab any comment that may or may...
42
by: mellyshum123 | last post by:
I need to read in a comma separated file, and for this I was going to use fgets. I was reading about it at http://www.cplusplus.com/ref/ and I noticed that the document said: "Reads characters...
15
by: linq936 | last post by:
Hi, I am reading book <<Expert C Programming>>, it has the following quiz, a //* //*/ b In C and C++ compiler what does the above code trun out? I think it is simple for C compiler, it is...
3
by: ºa¤Ö | last post by:
We are developing ASP.NET web application and using Visual source safe (VSS) to control our source code We developed a user control and it will been used by different project. I know there have...
2
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 7 Feb 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:30 (7.30PM). In this month's session, the creator of the excellent VBE...
0
by: MeoLessi9 | last post by:
I have VirtualBox installed on Windows 11 and now I would like to install Kali on a virtual machine. However, on the official website, I see two options: "Installer images" and "Virtual machines"....
0
by: Aftab Ahmad | last post by:
Hello Experts! I have written a code in MS Access for a cmd called "WhatsApp Message" to open WhatsApp using that very code but the problem is that it gives a popup message everytime I clicked on...
0
by: Aftab Ahmad | last post by:
So, I have written a code for a cmd called "Send WhatsApp Message" to open and send WhatsApp messaage. The code is given below. Dim IE As Object Set IE =...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
by: marcoviolo | last post by:
Dear all, I would like to implement on my worksheet an vlookup dynamic , that consider a change of pivot excel via win32com, from an external excel (without open it) and save the new file into a...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...

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.