XML documentation - <example> does not work!

J

John Mark Howell

When using the example straight out of the MSDN and using the Visual Studio
2003's Build Comment Web Pages, you will not see the <example> section. It
is in the generated XML file but I do not see it in the VS window. Does
anyone know how to get that to show up?

A second question is where is the XSL and CSS that VS is using to display
the XML?

Try the following example straight from the MSDN help:
/// <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>
public static int GetZero()
{
return 0;
}
 
M

Michael Bird

You'll find that there are several MS listed comment tags that do not show
up when you generate the web pages. That is, I believe, a limit on the
engine thwy use to generate the pages. You could look into NDoc, it's an
open source engine for generating the help from XML comments.
 

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