Well, actually it does not create anything in the code comment pages
generated by VS.NET. Summary and Remarks will show up there, but not
description.
VS .NET cannot generate MSDN like documentation. You need to use some
tool for this, for example our VSdocman.
FYI, the link you provided redirects to
http://msdn2.microsoft.com/en-us/library/t97s7bs3.aspx, which an article
about the String.Trim() method.
That's correct. I posted this link as random example of how it looks
like. This article contains "Example" section with the code showing how
to use it. When you use Trim method in your code and press F1, you'll
get this MSDN topic.
If you use <exampletag in your own method, you can do the same. You
can generate MSDN documentation for it (using 3rd party tool) which will
contain "Example" section with your code samples.
If you have for example property prop1 with the following comment (not
complete here):
/// <summary>Our sample property.</summary>
/// <remarks>
/// This property is really interesting.
/// </remarks>
/// <value>Some nice text.</value>
/// <example>This is an example how to use it:
/// <para></para>
/// <code>try
/// {
/// if (this.prop1 != @"hello&qu ot;)
/// {
/// return SampleEnum.valu e2;
/// }
/// else
/// {
/// return SampleEnum.valu e3;
/// }
/// }
/// catch (Exception ex)
/// {
/// return SampleEnum.valu e1;
/// }</code></example>
/// <author>Peter Macej</author>
/// <version>2.0</version>
/// <revision>27</revision>
/// <copyright>(c ) 2006 Helixoft</copyright>
/// <todo>Improve exception handling</todo>
/// <seealso cref="TestDLL.D llClass1.prop2" >
/// Another property
/// </seealso>
public string prop1
then our VSdocman generates the help page for it available at
http://tinyurl.com/r86vf.
--
Peter Macej
Helixoft -
http://www.helixoft.com
VSdocman - Commenter and generator of class documentation for C#, VB
..NET and ASP .NET code
