473,399 Members | 2,774 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,399 software developers and data experts.

Do XML Documentation Tags like <see>, <seealso>, <list> etc. work?

I'd like to use the XML Documentation Tags to comment my C# code. But many
of the tags do not have any effect when I execute the "Build Comment Web
Pages" menu.

For example, the <list> tag gets reendered as is. The resulting HTML page
contains the exact same tags, which are not valid HTML. The same with <see>
or <see also>.

Isn't this function supposed to transform these tags into valid HTML? Did
anybody see this work properly?

Regards,
Tom


Nov 15 '05 #1
2 2054
"Tom Vogel" <tv**@yahoo.com> wrote in message
news:%2****************@TK2MSFTNGP10.phx.gbl...
I'd like to use the XML Documentation Tags to comment my C# code. But many
of the tags do not have any effect when I execute the "Build Comment Web
Pages" menu.

For example, the <list> tag gets reendered as is. The resulting HTML page
contains the exact same tags, which are not valid HTML. The same with <see> or <see also>.

Isn't this function supposed to transform these tags into valid HTML? Did
anybody see this work properly?

Regards,
Tom


I use NDoc, and <see> and <seealso> work just as expected.

http://ndoc.sourceforge.net/wiki

Erik
Nov 15 '05 #2
This is really an excellent tool. Thanks for the help.

Tom
I use NDoc, and <see> and <seealso> work just as expected.

http://ndoc.sourceforge.net/wiki

Erik

Nov 15 '05 #3

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

Similar topics

0
by: gary hitch | last post by:
Trying to generate html documentation with the built-in Build Comment Web pages tool of .Net Many of the comments are simply eliminated in the results files such as : /// <exception...
1
by: Ole Hanson | last post by:
I would like to be able to generate documentation for a custom configuration file (xml) to enable future support engineers to understand applicable values to the various elements inside the...
3
by: Jesper Odgaard | last post by:
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...
2
by: C# Learner | last post by:
I've made a class library containing a static method. This method is documented with XML-type comments: /// <summary> /// Foobar. /// </summary> public static string FooBar() { // etc...
8
by: Will Pittenger | last post by:
I have a Windows program C# .NET solution where when I update its XML documentation, some tags are not recognized and turned into the corresponding HTML. Those tags include <c>, <code>, <para>,...
1
by: Mike | last post by:
Hi, I saw that there is a <value> tag that is used for class' properties. Is there a similar tag for constants too, or should I use <value>? Thanks Mike
2
by: UJ | last post by:
Is there a way to have VS.NET automatically generate the documentation for a class for you? I've been told by a friend that uses C# that in C# you can use the ///. Is there anything like that in...
10
by: Lloyd Dupont | last post by:
Let say I have 2 methods: void BeginGroup(); void BeginGroup(string msg); when I want to refer to them I write /// <see cref="BeginGroup"/> But this cause a compiler warning, where my...
4
by: Water Cooler v2 | last post by:
Having documented your C# code with the XML tags for documentation, how do you then generate a HTML help file (.chm) for it? I am talking about code decoration tags such as: ///<summary>...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new...

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.