468,510 Members | 1,736 Online
Bytes | Developer Community
New Post

Home Posts Topics Members FAQ

Post your question to a community of 468,510 developers. It's quick & easy.

XML documentation - <example> does not work!

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;
}

Nov 16 '05 #1
1 1442
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.
"John Mark Howell" <jm*********@hotmail.com> wrote in message
news:Oa**************@TK2MSFTNGP12.phx.gbl...
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;
}

Nov 16 '05 #2

This discussion thread is closed

Replies have been disabled for this discussion.

Similar topics

3 posts views Thread by Mark Bennett | last post: by
11 posts views Thread by Les Paul | last post: by
3 posts views Thread by Jesper Odgaard | last post: by
17 posts views Thread by cpptutor2000 | last post: by
8 posts views Thread by Scott M. | last post: by
7 posts views Thread by Jim in Arizona | last post: by
1 post views Thread by fmendoza | last post: by
By using this site, you agree to our Privacy Policy and Terms of Use.