SA1604: Element documentation should have summary

Cause

The Xml header documentation for a C# element is missing a <summary> tag.

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 the element documentation is missing a <summary> tag.

For this rule, an element with a top-level <exclude/> tag is treated as a private element, even if it is publicly accessible. A summary is still required when documentPrivateElements is enabled (or documentPrivateFields for fields). The tag may appear directly in the documentation comment or in included documentation. It does not disable other documentation rules.

How to fix violations

To fix a violation of this rule, add and fill-in a <summary> tag for the element, containing a description of the element.

The following example shows a class containing a documentation header without a summary.

/// <remarks>A remark.</remarks>
public class Customer
{
}

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1604:ElementDocumentationMustHaveSummary", Justification = "Reviewed.")]

#pragma warning disable SA1604 // ElementDocumentationMustHaveSummary
#pragma warning restore SA1604 // ElementDocumentationMustHaveSummary