XML Documentation Comments
Tag:
<summary>
Type: Applies To: Defined By: Syntax: Parameters:
Top-Level All Types and Members. Microsoft <summary>description</summary>
Tags Descriptions - <summary>
description: A summary of the object. Remarks: • • •
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.
Example: /// <summary> /// Gets or sets a /// <see cref="T:System.Windows.Media.Brush"/> /// used to fill the area between the borders of a /// <see cref="T:System.Windows.Controls.InkCanvas"/> /// see <see langword="null"/> as reference /// </summary> public int MyProp { get { return _myProp; } set { _myProp = value; } }
http://www.dynicity.com/products/XMLDocComments.aspx
Page 52 of 67
October 3, 2007