The <summary> tag is used to provide a short description of a type or member.

<summary>description</summary>

where:

description

A summary of the object.

Applies To

All Types and Members.

Remarks

This tag should be treated as mandatory for all publicly accesible types and members. It is the primary description used by IntelliSense and the Object Browser in VisualStudio, and most other development tools.

Use <remarks> to add supplemental information to a type or member description.

Example

[C#]
/// text for class MyClass
public class MyClass
{
   /// <summary>MyMethod is a method in the MyClass class.
   /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine"/> for information about output statements.</para>
   /// <seealso cref="MyClass.Main"/>
   /// </summary>
   public static void MyMethod(int Int1)
   {
   }

   /// text for Main
   public static void Main ()
   {
   }
}

See Also

Tag Usage | NDoc Tags | <remarks> | Microsoft's definition

---

NDoc development is hosted by Send feedback on this topic