By using this site, you agree to our updated Privacy Policy and our Terms of Use. Manage your Cookies Settings.
454,673 Members | 1,302 Online
Bytes IT Community
+ Ask a Question
Need help? Post your question and get tips & solutions from a community of 454,673 IT Pros & Developers. It's quick & easy.

<example> tag doesn't work

P: n/a
Hi,

When documenting my code using comment web pages from the
visual studio .Net 2002 ide, it seems that it ignores the
<example> tag. Except for this tag everything works fine.
Can I customize the web pages to include examples?

brgds Jesper.

/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the
GetZero method.
/// <code>
/// class MyClass
/// {
/// public static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
Nov 13 '05 #1
Share this Question
Share on Google+
3 Replies


P: n/a
I know that I am replying to an older message, but wanted to bring up the
same issues with .Net 2003. I commented a lot of code last night. For some
of the methods in my class, I used the <summary> </summary> tags. Well, the
IDE does it automatically for you with ///.

Anyway, inside the <summary> area, I used <para></para> to start a new
paragraph. When I used the option to build comment web pages today from the
IDE, I checked them out and saw that the <para> tags were ignored.
Everything was run together on one line.

Anyone have any thoughts or suggestions on this?

Thanks.

"Jesper Odgaard" <je****@hotmail.com> wrote in message
news:99****************************@phx.gbl...
Hi,

When documenting my code using comment web pages from the
visual studio .Net 2002 ide, it seems that it ignores the
<example> tag. Except for this tag everything works fine.
Can I customize the web pages to include examples?

Nov 15 '05 #2

P: n/a
Kerry,

This reply applies to C#, XML Documentation.

The Comment Web Report, in my opinion, has many flaws. I've seen a lot
of people using a OpenSource XML Documentor called "NDoc". This
program produces MSDN and other style docs.

As much as I've used this program, I have not been disappointed. It
does have some formatting "quarks" but don't all programs. With that
said it seems to follow/allow all of the XML Documentation Tags.

I think it's great your using the comments fully. I requier all my
programers to use the /doc directive to inforce proper commenting.

Hope this helps.

MSDN URL Ref Page:
"ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcwlkxmldocumentationtutorial.htm"

Glen Jones MCSD

"Kerry Sanders" <di****@yahoo.com> wrote in message news:<VP*******************@bignews4.bellsouth.net >...
I know that I am replying to an older message, but wanted to bring up the
same issues with .Net 2003. I commented a lot of code last night. For some
of the methods in my class, I used the <summary> </summary> tags. Well, the
IDE does it automatically for you with ///.

Anyway, inside the <summary> area, I used <para></para> to start a new
paragraph. When I used the option to build comment web pages today from the
IDE, I checked them out and saw that the <para> tags were ignored.
Everything was run together on one line.

Anyone have any thoughts or suggestions on this?

Thanks.

"Jesper Odgaard" <je****@hotmail.com> wrote in message
news:99****************************@phx.gbl...
Hi,

When documenting my code using comment web pages from the
visual studio .Net 2002 ide, it seems that it ignores the
<example> tag. Except for this tag everything works fine.
Can I customize the web pages to include examples?

Nov 15 '05 #3

P: n/a
Yep... thanks for the reply. In the past, our company has not had strict
rules for documenting and commenting code. Things are changing... finally.
I really love the XML documentation aspects of C#. I will see if I can find
NDoc or another utility to see if I can produce a good report from the XML
documentation.

"Glen Jones" <gl********@hotmail.com> wrote in message
news:ba**************************@posting.google.c om...
Kerry,

This reply applies to C#, XML Documentation.

The Comment Web Report, in my opinion, has many flaws. I've seen a lot
of people using a OpenSource XML Documentor called "NDoc". This
program produces MSDN and other style docs.

As much as I've used this program, I have not been disappointed. It
does have some formatting "quarks" but don't all programs. With that
said it seems to follow/allow all of the XML Documentation Tags.

I think it's great your using the comments fully. I requier all my
programers to use the /doc directive to inforce proper commenting.

Hope this helps.

MSDN URL Ref Page:
"ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcwlkxmldocumentationtutorial.htm"

Glen Jones MCSD

Nov 15 '05 #4

This discussion thread is closed

Replies have been disabled for this discussion.