| TypeName | SA1610PropertyDocumentationMustHaveValueText |
| CheckId | SA1610 |
| Category | Documentation Rules |
The Xml header documentation for a C# property contains an empty <value> tag.
C# syntax provides a mechanism for inserting documentation for classes and elements directly into the code, through the use of Xml documentation headers. For an introduction to these headers and a description of the header syntax, see the following article: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments.
The documentation for properties may include a <value> tag, which describes the value held by the property.
A violation of this rule occurs when the <value> tag for a property is empty.
To fix a violation of this rule, fill-in a description of the value held by the property within the <value> tag.
Example:
The following example shows a property which contains a <value> tag within its documentation header.
/// <summary>
/// Gets the name of the customer.
/// </summary>
/// <value>The name of the customer.</value>
public bool Name
{
get { return this.name; }
}[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1610:PropertyDocumentationMustHaveValueText", Justification = "Reviewed.")]#pragma warning disable SA1610 // PropertyDocumentationMustHaveValueText
#pragma warning restore SA1610 // PropertyDocumentationMustHaveValueText