StyleCop 4.3 > StyleCop 4.3 Rules > Documentation Rules > SA1637: FileHeaderMustContainFileName

StyleCop 4.3	Send comments on this topic.
SA1637: FileHeaderMustContainFileName

Glossary Item Box

TypeName	FileHeaderMustContainFileName
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="Sprocket Enterprises">

// </copyright>

//-----------------------------------------------------------------------

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

//-----------------------------------------------------------------------

// <copyright file="Widget.cs" company="Sprocket Enterprises">

// </copyright>

//-----------------------------------------------------------------------

How to Fix Violations

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