TypeName

PropertyDocumentationMustHaveValue

CheckId

SA1609

Category

Documentation Rules

Cause

The Xml header documentation for a C# property does not contain a <value> tag.

Rule Description

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: http://msdn.microsoft.com/en-us/magazine/cc302121.aspx.

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 missing.

How to Fix Violations

To fix a violation of this rule, add and fill-in a <value> tag within the documentation header for the property.

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; }

    }