TypeName

ElementDocumentationMustNotHaveDefaultSummary

CheckId

SA1608

Category

Documentation Rules

Cause

The <summary> tag within an element’s Xml header documentation contains the default text generated by Visual Studio during the creation of the element.

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.

Visual Studio provides helper functionality for adding new elements such as classes to a project. Visual Studio will create a default documentation header for the new class and fill in this header with default documentation text.

A violation of this rule occurs when the <summary> tag for a code element still contains the default documentation text generated by Visual Studio.

How to Fix Violations

To fix a violation of this rule, replace the default documentation text with new text describing the contents of the code element.

The following example shows a class which contains the default summary text generated by Visual Studio.

    /// <summary>

    /// Summary description for the Example class.

    /// </summary>

    public class Example

    {

    }