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

T

Tom Vogel

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
 
E

Erik Frey

Tom Vogel said:
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
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
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top