This documentation is archived and is not being maintained.




A summary of the object.


The <summary> tag should be used to describe a type or a type member. Use <remarks> to add supplemental information to a type description.

The text for the <summary> tag is the only source of information about the type in IntelliSense, and is also displayed in the Object Browser and in the Code Comment Web Report.

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


// xml_summary_tag.cs
// compile with: /doc:xml_summary_tag.xml

/// 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

Recommended Tags for Documentation Comments