The <value> tag is used to describe the value of a property. This is a top-level tag.

Syntax

<value>description</value>

By convention, properties should always have a <value> tag.

For read-only properties, the text in the <value> tag will often be substantially the same as that in the <summary> tag.

Examples

Visual Basic

Copy CodeCopy Code

''' <summary>Our sample property.</summary>

''' <value>String containing our value.</value>

Property prop1() As String

C#

Copy CodeCopy Code

/// <summary>Our sample property.</summary>

/// <value>String containing our value.</value>

public string prop1

 

The sections in bold are added automatically when using Add XML Comment from pop-up menu.

See Also

XML Comments