473,322 Members | 1,473 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,322 software developers and data experts.

c# comments

I have added couple of comments tags for a method like below....

/// <summary
/// MeMethod is responsible for add operation to the employee operation
/// <para>Here's how you could make a second paragraph in a description.</para
/// </summary

When build the xml file through the tools->Build comment web pag, result is....

MeMethod is responsible for add operation to the employee operation. <para>Here's how you could make a second paragraph in a description.</para>

You can see that the <para> tag also appear in the summary. Can anyone tell me the reason? Or this is not the way to do this

Thanks in advance

Dinesh
Nov 15 '05 #1
4 1556
<para> is not a valid childtag for the <summary> tag.

HTH,

Andreas Håkansson

"Dinesh" <an*******@discussions.microsoft.com> skrev i meddelandet
news:05**********************************@microsof t.com...
I have added couple of comments tags for a method like below.....

/// <summary>
/// MeMethod is responsible for add operation to the employee operation.
/// <para>Here's how you could make a second paragraph in a description.</para> /// </summary>

When build the xml file through the tools->Build comment web pag, result is.....
MeMethod is responsible for add operation to the employee operation. <para>Here's how you could make a second paragraph in a description.</para>
You can see that the <para> tag also appear in the summary. Can anyone tell me the reason? Or this is not the way to do this?
Thanks in advance.

Dinesh

Nov 15 '05 #2
Hello

Check the documentation for <para> from MSDN:
Remarks
The <para> tag is for use inside a tag, such as <summary>, <remarks>, or
<returns>, and lets you add structure to the text.

Relu.
"Andreas Håkansson" <andy.h (at) telia.com> wrote in message
news:uc**************@TK2MSFTNGP09.phx.gbl...
<para> is not a valid childtag for the <summary> tag.

HTH,

Andreas Håkansson

"Dinesh" <an*******@discussions.microsoft.com> skrev i meddelandet
news:05**********************************@microsof t.com...
I have added couple of comments tags for a method like below.....

/// <summary>
/// MeMethod is responsible for add operation to the employee operation.
/// <para>Here's how you could make a second paragraph in a

description.</para>
/// </summary>

When build the xml file through the tools->Build comment web pag, result

is.....

MeMethod is responsible for add operation to the employee operation.

<para>Here's how you could make a second paragraph in a

description.</para>

You can see that the <para> tag also appear in the summary. Can anyone

tell me the reason? Or this is not the way to do this?

Thanks in advance.

Dinesh


Nov 15 '05 #3
I just used the lazy method and relied on what intellisence of VS.NET 2003
told
me, and still is telling me. =)

//Andreas

"Georgescu Aurelian" <re**@itprovision.com> skrev i meddelandet
news:%2****************@TK2MSFTNGP12.phx.gbl...
Hello

Check the documentation for <para> from MSDN:
Remarks
The <para> tag is for use inside a tag, such as <summary>, <remarks>, or
<returns>, and lets you add structure to the text.

Relu.
"Andreas Håkansson" <andy.h (at) telia.com> wrote in message
news:uc**************@TK2MSFTNGP09.phx.gbl...
<para> is not a valid childtag for the <summary> tag.

HTH,

Andreas Håkansson

"Dinesh" <an*******@discussions.microsoft.com> skrev i meddelandet
news:05**********************************@microsof t.com...
I have added couple of comments tags for a method like below.....

/// <summary>
/// MeMethod is responsible for add operation to the employee operation. /// <para>Here's how you could make a second paragraph in a

description.</para>
/// </summary>

When build the xml file through the tools->Build comment web pag,
result
is.....

MeMethod is responsible for add operation to the employee operation.

<para>Here's how you could make a second paragraph in a

description.</para>
You can see that the <para> tag also appear in the summary. Can anyone

tell me the reason? Or this is not the way to do this?

Thanks in advance.

Dinesh



Nov 15 '05 #4
KD
Try using Ndoc. Its tag support is far better than "Build comment web pages"
and the output looks a lot prettier :)

http://sourceforge.net/projects/ndoc/

regards,
Kevin

"Dinesh" <an*******@discussions.microsoft.com> wrote in message
news:05**********************************@microsof t.com...
I have added couple of comments tags for a method like below.....

/// <summary>
/// MeMethod is responsible for add operation to the employee operation.
/// <para>Here's how you could make a second paragraph in a description.</para> /// </summary>

When build the xml file through the tools->Build comment web pag, result is.....
MeMethod is responsible for add operation to the employee operation. <para>Here's how you could make a second paragraph in a description.</para>
You can see that the <para> tag also appear in the summary. Can anyone tell me the reason? Or this is not the way to do this?
Thanks in advance.

Dinesh

Nov 15 '05 #5

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

Similar topics

4
by: Sims | last post by:
Hi, I proud myself in having good comments, (/**/, // etc...), all over my scripts as well as a very descriptive section at the beginning of the script. No correct me if i am wrong but php must...
17
by: lkrubner | last post by:
I've got a PHP application that's 2 megs in size. Of that, my guess is 200k-400k is comments. Do they impose a performance hit? I've been postponing any kind of optimization, but at some point I'll...
4
by: Uwe Ziegenhagen | last post by:
Hello, my fellows and me implement a c++ tool that is able to divide blank/tab separated files into <number>, <text>, <c-singlelinecomment> and <multilinecomment>. So far it's not working bad,...
28
by: Benjamin Niemann | last post by:
Hello, I've been just investigating IE conditional comments - hiding things from non-IE/Win browsers is easy, but I wanted to know, if it's possible to hide code from IE/Win browsers. I found...
4
by: lorinh | last post by:
Hi Folks, I'm trying to strip C/C++ style comments (/* ... */ or // ) from source code using Python regexps. If I don't have to worry about comments embedded in strings, it seems pretty...
40
by: Edward Elliott | last post by:
At the risk of flogging a dead horse, I'm wondering why Python doesn't have any multiline comments. One can abuse triple-quotes for that purpose, but that's obviously not what it's for and doesn't...
7
by: Bob Stearns | last post by:
Several weeks ago I asked what comments I could pass to DB2 in a SELECT statement. I don't remember whether I said via PHP/ODBC. I was assured that both /* */ style comment blocks and -- comment...
98
by: tjb | last post by:
I often see code like this: /// <summary> /// Removes a node. /// </summary> /// <param name="node">The node to remove.</param> public void RemoveNode(Node node) { <...> }
40
by: jacob navia | last post by:
Recently we had poor Mr "teapot" that was horrified at the heresy of lcc-win of accepting // comments. C is a nice language, and you can do anything with it, inclusive a program that transforms...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
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...
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: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
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...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...

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.