-
Notifications
You must be signed in to change notification settings - Fork 23
SA1637
TypeName |
FileHeaderMustContainFileName |
CheckId |
SA1637 |
Category |
Documentation Rules |
The file header at the top of a C# code file is missing the file name.
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>
//-----------------------------------------------------------------------
To fix a violation of this rule, add a file tag containing the name of the file.
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1637:FileHeaderMustContainFileName", Justification = "Reviewed.")]
- - SA0102 - Clean Install
- - Download
- - Documentation Rules - Layout Rules - Maintainability Rules - Naming Rules - Ordering Rules - Readability Rules - Spacing Rules - Suppressions
- - Adding a custom StyleCop settings page - Adding custom rule settings - Authoring a custom styleCop rule - Authoring rules metadata - Custom CSharp Language Service - Custom MSBuild Integration - Hosting StyleCop in a Custom Environment - Installing a Custom Rule - Integrating StyleCop Into Build Environments - Integrating StyleCop into MSBuild - Writing Custom Rules for StyleCop