StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules > SA1606: ElementDocumentationMustHaveSummaryText

StyleCop 4.3	Send comments on this topic.
SA1606: ElementDocumentationMustHaveSummaryText

Glossary Item Box

TypeName	ElementDocumentationMustHaveSummaryText
CheckId	SA1606
Category	Documentation Rules

Cause

The <summary> tag within the documentation header for a C# code element is empty.

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.

A violation of this rule occurs when the documentation header for an element contains an empty <summary> tag which does not contain a description of the element.

How to Fix Violations

To fix a violation of this rule, fill-in the <summary> tag with a description of the code element.

Example

The following example shows a method which contains an empty <summary> tag.

/// <summary> </summary>

/// <param name="customerId">The ID of the customer to find.</param>

/// <returns>The customer, or null if the customer could not be

/// found.</returns>

public Customer FindCustomer(int customerId)

{

// ... finds the customer ...

}