Sandcastle XML Comments Guide
|
value |
This element is used to provide a more detailed description of a property value.
Syntax
This top-level element is valid on all properties. Use it when necessary to provide more detailed information about a property's value such as how it is used, valid values, etc.
<value>description</value>
Remarks
The value description will only appear in the help file and can be as long as necessary. It is similar in nature to the remarks element but is specific to property members.
Examples
/// <summary> /// This is used to get or set the sample number /// </summary> /// <value>The value can be any valid integer</value> /// <conceptualLink target="f512d714-e100-4296-916c-99a46e572e9d" /> public int SampleNumber { get; set; }
See Also