SA1632.md

SA1632

TypeName	SA1632DocumentationTextMustMeetMinimumCharacterLength
CheckId	SA1632
Category	Documentation Rules

⚠️ This rule has been intentionally omitted from StyleCop Analyzers. See KnownChanges.md for additional information.

Cause

From StyleCop 4.5 this rule is disabled by default.

A section of the Xml header documentation for a C# element is too short.

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 part of the documentation is too short. This can often indicate that the documentation is not descriptive. For example:

/// <summary>
/// A name
/// </summary>
public class Name
{
    ...
}

How to fix violations

To fix a violation of this rule, rewrite the documentation text using grammatically proper and descriptive language. In most cases, doing so will cause the length of the documentation text to be greater than the minimum length which causes this rule to fire.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1632:DocumentationTextMustMeetMinimumCharacterLength", Justification = "Reviewed.")]

#pragma warning disable SA1632 // DocumentationTextMustMeetMinimumCharacterLength
#pragma warning restore SA1632 // DocumentationTextMustMeetMinimumCharacterLength