<remarks> (C# Programming Guide)

  • Article
<remarks>description</remarks>

Parameters

  • Description
    A description of the member.

Remarks

The <remarks> tag is used to add information about a type, supplementing the information specified with <summary>. This information is displayed in the Object Browser.

Compile with /doc to process documentation comments to a file.

Example

// compile with: /doc:DocFileName.xml 

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

See Also

Reference

Recommended Tags for Documentation Comments (C# Programming Guide)

Concepts

C# Programming Guide