Skip to content
ptittof57 edited this page Aug 15, 2015 · 5 revisions
<title>SA1637: FileHeaderMustContainFileName</title> <script src="script/helpstudio.js" type="text/javascript"></script> <script src="script/StandardText.js" type="text/jscript"></script>
<script type="text/jscript">WritePageTop(document.title);</script>

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="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.")]
Clone this wiki locally