Permalink
Fetching contributors…
Cannot retrieve contributors at this time
58 lines (44 sloc) 1.45 KB

SA1637

TypeName SA1637FileHeaderMustContainFileName
CheckId SA1637
Category Documentation Rules

Cause

The file header at the top of a C# code file is missing the file name.

Rule description

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

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

A file header should include a file tag containing the name of the file, as follows:

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

How to fix violations

To fix a violation of this rule, add a file tag containing the name of the file.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1637:FileHeaderMustContainFileName", Justification = "Reviewed.")]
#pragma warning disable SA1637 // FileHeaderMustContainFileName
#pragma warning restore SA1637 // FileHeaderMustContainFileName