Some comment tags do not appear in Comment Web Page

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

marcog - 28 Sep 2004 22:05 GMT

When I try to use certain tags such as <example> or <exception>, no output is
generated in the Comment Web Page. <summary>, <remark>, <params> and
<returns> work as advertised. I have the output xml file name set to match
the project and it is being generated successfully. Is the documentation
wrong? Are these tags not really supported?

Reply to this Message

"Gary Chang" - 29 Sep 2004 10:26 GMT

Hi,

I have tested the <example> or <exception> tag in a C# project, it could be
generated in the corresponding XML file well, but not appeared in the
comment Web page, is this the scenario you concerned?

> Is the documentation wrong? Are these tags not really supported?

Based on the following MSDN doc:
Recommended Tags for Documentation Comments
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/
vclrftagsfordocumentationcomments.asp

those listed tags are supported to generated XML doc, but not guarantee all
the tags would be supported in the VS.NET generated comment Web page, so
they could be processed by the developer's custom parser tool...

Thanks for your understanding!

Best regards,

Gary Chang
Microsoft Online Partner Support

Signature

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.

--------------------

Reply to this Message

Rate this thread:

Some comment tags do not appear in Comment Web Page

Free Magazines