TypeName

DocumentationTextMustBeginWithACapitalLetter

CheckId

SA1628

Category

Documentation Rules

Cause

A section of the Xml header documentation for a C# element does not begin with a capital letter.

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 part of the documentation does not begin with a capital letter. For example, the summary text in the documentation below begins with a lower-case letter:

    /// <summary>

    /// joins a first name and a last name together into a single string.

    /// </summary>

    /// <param name="firstName">The first name.</param>

    /// <param name="lastName">The last name.</param>

    /// <returns>The joined names.</returns>

    public string JoinNames(string firstName, string lastName)

    {

        ...

    }

How to Fix Violations

To fix a violation of this rule, ensure that all sections of the documentation begin with a capital letter.