Click or drag to resize
Sandcastle XML Comments Guide

remarks

This element is used to provide a more detailed description of the type or member.

Syntax

This top-level element is valid on all types and type members.

<remarks>description</remarks>
Remarks

Use it when necessary to provide more detailed information about the type or member such as how it is used, its processing, etc. Remarks will only appear in the help file and can be as long as necessary.

Examples
/// <summary>
/// The summary is a brief description of the type or type member and will
/// be displayed in IntelliSense and the Object Browser.
/// </summary>
/// <remarks>The remarks element should be used to provide more detailed information
/// about the type or member such as how it is used, its processing, etc.
/// 
/// <para>Remarks will only appear in the help file and can be as long as
/// necessary.</para></remarks>
/// <conceptualLink target="c3743eaf-9ef2-4d35-8f59-876f1e48a6a8" />
/// <conceptualLink target="3671b61e-0695-4f0f-bcb5-7cf9108dd642" />
public void SummaryRemarksExample()
{
}
See Also