SA1639.md

SA1639

TypeName	SA1639FileHeaderMustHaveSummary
CheckId	SA1639
Category	Documentation Rules

💡 This rule is disabled by default.

Cause

The file header at the top of a C# code file does not contain a filled-in summary tag.

Rule description

A violation of this rule occurs when the file header at the top of a C# file does not contain a valid summary tag.

For example:

//-----------------------------------------------------------------------
// <copyright file="Widget.cs" company="My Company">
//     Custom company copyright tag.
// </copyright>
//-----------------------------------------------------------------------

If this rule is enabled, the file header should contain a summary tag. For example:

//-----------------------------------------------------------------------
// <copyright file="Widget.cs" company="My Company">
//     Custom company copyright tag.
// </copyright>
// <summary>This is the Widget class.</summary>
//-----------------------------------------------------------------------

How to fix violations

To fix a violation of this rule, add and fill-in a summary tag describing the contents of the file.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1639:FileHeaderMustHaveSummary", Justification = "Reviewed.")]

#pragma warning disable SA1639 // FileHeaderMustHaveSummary
#pragma warning restore SA1639 // FileHeaderMustHaveSummary