c# comments

  • Thread starter Thread starter Guest
  • Start date Start date
G

Guest

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
 
<para> is not a valid childtag for the <summary> tag.

HTH,

Andreas Håkansson

Dinesh said:
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
Click to expand...
description. said:
/// </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.
Click to expand...
You can see that the <para> tag also appear in the summary. Can anyone
Click to expand...
tell me the reason? Or this is not the way to do this?
 
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.
 
I just used the lazy method and relied on what intellisence of VS.NET 2003
told
me, and still is telling me. =)

//Andreas
 
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 said:
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
Click to expand...
description. said:
/// </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.
Click to expand...
You can see that the <para> tag also appear in the summary. Can anyone
Click to expand...
tell me the reason? Or this is not the way to do this?
 
Back
Top