Navigation:  StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules >

SA1610: PropertyDocumentationMustHaveValueText

Previous pageReturn to chapter overviewNext page
StyleCop 4.3

Send comments on this topic.

SA1610: PropertyDocumentationMustHaveValueText

Glossary Item Box

TypeName
PropertyDocumentationMustHaveValueText

CheckId

SA1610

Category

Documentation Rules

 

Cause

The Xml header documentation for a C# property contains an empty <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 empty.

How to Fix Violations

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

   }

 

 

 


© Microsoft Corporation. All Rights Reserved.