<value> (C# Programming Guide)
<value>property-description</value>
Parameters
- property-description
A description for the property.
Remarks
The <value> tag lets you describe the value that a property represents. Note that when you add a property via code wizard in the Visual Studio .NET development environment, it will add a <summary> tag for the new property. You should then manually add a <value> tag to describe the value that the property represents.
Compile with /doc to process documentation comments to a file.
Example
// compile with: /doc:DocFileName.xml
/// text for class Employee
public class Employee
{
private string _name;
/// <summary>The Name property represents the employee's name.</summary>
/// <value>The Name property gets/sets the _name data member.</value>
public string Name
{
get
{
return _name;
}
set
{
_name = value;
}
}
}
/// text for class MainClass
public class MainClass
{
/// text for Main
static void Main()
{
}
}
See Also
Reference
Recommended Tags for Documentation Comments (C# Programming Guide)