SA1602.md

SA1602

TypeName	SA1602EnumerationItemsMustBeDocumented
CheckId	SA1602
Category	Documentation Rules

Cause

An item within a C# enumeration is missing an Xml documentation header.

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: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments.

A violation of this rule occurs when an item within an enumeration is missing a header. For example:

/// <summary>
/// Types of animals.
/// </summary>
public enum Animals
{
    Dog,
    Cat,
    Horse
}

How to fix violations

To fix a violation of this rule, add a documentation header for each item within the enum. For example:

/// <summary>
/// Types of animals.
/// </summary>
public enum Animals
{
    /// <summary>
    /// Represents a dog.
    /// </summary>
    Dog,

    /// <summary>
    /// Represents a cat.
    /// </summary>
    Cat,

    /// <summary>
    /// Represents a horse.
    /// </summary>
    Horse
}

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1602:EnumerationItemsMustBeDocumented", Justification = "Reviewed.")]

#pragma warning disable SA1602 // EnumerationItemsMustBeDocumented
#pragma warning restore SA1602 // EnumerationItemsMustBeDocumented