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.
Syntax
<summary>text</summary>
Examples
Visual Basic
|
 Copy Code
|
''' <summary>Our sample property.</summary>
''' <remarks>This property is really interesting.</remarks>
''' <value>Some nice text.</value>
''' <seealso cref="TestDLL.DllClass1.prop2">Another interesting
''' property</seealso>
Property prop1() As String
|
C#
|
Copy Code
|
/// <summary>Our sample property.</summary>
/// <remarks>This property is really interesting.</remarks>
/// <value>Some nice text.</value>
/// <seealso cref="TestDLL.DllClass1.prop2">Another interesting
/// property</seealso>
public string prop1
|
|
See Also
