Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 1.73 KB

SA1641.md

File metadata and controls

52 lines (39 loc) · 1.73 KB
Raw

SA1641

TypeName SA1641FileHeaderCompanyNameTextMustMatch
CheckId SA1641
Category Documentation Rules

Cause

The file header at the top of a C# code file does not contain the appropriate company name text.

Rule description

A violation of this rule occurs when the file header at the top of a C# file does not contain the company name text that has been specified for the project.

In order to enable this rule, the companyName property must have been specified. In addition to that, the xmlHeader property must be either omitted or have a value of true. See the configuration section for details on how to set this up.

With these settings in place, every file within the project should contain the required company name text within its file header copyright tag, as shown in the example below:

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

How to fix violations

To fix a violation of this rule, add your company's standard company name text to the file header copyright tag.

How to suppress violations

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