NDoc User's Guide

NDoc 1.3

<remarks>

[This is preliminary documentation and subject to change]

The <remarks> tag describes additional information about a type or member..

<remarks>description</remarks>

where:

description: Additional information regarding the type or member.

Applies To

All Types and Members.

Remarks

The <remarks> tag is used to add additional information about a type or member, supplementing the information specified with <summary>.

Example

[C#]
/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public class MyClass
{
   /// text for Main
   public static void Main ()
   {
   }
}

See Also

Tag Usage | NDoc Tags | Microsoft's definition