The <value> tag is used to describe the value of a property.
<value>property-description</value>
where:
- property-description
- A description for the property.
Applies To
Property.
Remarks
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.
Example
[C#] /// text for class MyClass public class MyClass { /// <summary>MyProperty is a property in the MyClass class.</summary> /// <value>A string containing the text "MyProperty String".</value> public string MyProperty() { get { return "MyProperty String"; } } }
See Also
Tag Usage | NDoc Tags | <summary> | Microsoft's definition
|
NDoc development is hosted by |
 |