<remarks> (C# Programming Guide)

 

Updated: July 20, 2015

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

<remarks>description</remarks>  

Parameters

Description
A description of the member.

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 window.

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

    // 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()
        {
        }
    }

C# Programming Guide
Recommended Tags for Documentation Comments

Show: