This documentation is archived and is not being maintained.

<remarks>

<remarks>description</remarks>

where:

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 and in the Code Comment Web Report.

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

Example

// xml_remarks_tag.cs
// compile with: /doc:xml_remarks_tag.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 MyClass
{
   /// text for Main
   public static void Main ()
   {
   }
}

See Also

Recommended Tags for Documentation Comments

Show: