Listing 1: Undocumented class library

using System;
namespace CommentsLibrary
{
public class DummyClass
{
public string UserName;

public int AddTwoNumbers(int a, int b)
{
return a+b;
}

public void SubtractTwoNumbers(int a, int b)
{
result = a-b;
}

}
}


Listing 2: Documented class library


using System;
namespace CommentsLibrary
{
/// <summary>
/// This class is strictly used for demonstrat
/// ing XML comments.
/// </summary>
/// public class DummyClass
{
/// <summary>
/// String field containing the User's name.
/// </summary>
/// public string UserName;

/// <summary>
/// This method adds two numbers and returns
/// the result.
/// </summary>
/// <param name="a">
/// The first number to be added.
/// </param>
/// <param name="b">
/// The second number to be added.
/// </param>
/// <returns>
/// An integer that is the result of the addi
/// tion.
/// </returns>
/// public int AddTwoNumbers(int a, int b)
{
return a+b;
}

/// <summary>
/// This method subtracts two numbers and
/// returns the
/// result.
/// </summary>
/// <param name="a">
/// The first number to be subtracted.
/// </param>
/// <param name="b">
/// The second number to be sub
/// tracted.
/// </param>
/// <param name="result">
/// The result of the subtraction.
/// </param>
/// public void SubtractTwoNumbers(int a, int b)
{
result = a-b;
}

}
}


Listing 3: Generated comments XML File.


<?xml version="1.0"?>
<doc>
<assembly>
<name>CommentsLibrary</name>
</assembly>
<members>
<member name="T:CommentsLibrary.
DummyClass">
<summary>
This class is strictly used for demonstrating XML comments.
</summary>
</member>
<member name="F:Comments
Library.DummyClass.UserName">
<summary>
String field containing the User's name.
</summary>
</member>
<member name="M:CommentsLibrary.DummyClass.
AddTwoNumbers(System.Int32,System.Int32)">
<summary>
This method adds two numbers and
returns the result.
</summary>
<param name="a">The first number to
be added.</param>
<param name="b">The second number to
be added.</param>
<returns>An integer that is the
result of the addition</returns>
</member>
<member name="M:CommentsLibrary.DummyClass.
SubtractTwoNumbers(System.Int32,
System.Int32,System.Int32)">
<summary>
This method subtracts two numbers and
returns the result.
</summary>
<param name="a">The first number to
be subtracted.</param>
<param name="b">The second number to
be subtracted.</param>
<param name="result">The result of
the subtraction.</param>
</member>
</members>
</doc>