Stylecop Suppress Message

January 13, 2012 · 4 min read

great tool from Microsoft to enforce code style rules. Sometimes we like to break 1 or more of its rules and very much like Complier should not complain about it anymore.

its easy by adding following attribute in  front of element that is going to break the Rule. In the following code its class.

[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:FileMayOnlyContainASingleClass", Justification = "its ok here")]

Major problem that I faced is getting correct “CheckId” of the rule. If compiling code by commenting the SuppressMessage Attribute you will get

Rule violation warring in the Error List Window e.g.

SA1402: A C# document may only contain a single class at the root level unless all of the classes are partial and are of the same type.

SuppressMessage is not working on the message that we receive in the Error List Window, it requires CheckId. So how to get Stylecop rules checkId.

Its Easy open Stylecop setting from right clicking on project

ProjectProperties

> StylecopSetting

Deselect all of the settings and save it by clicking “OK”.

then open up the “Settings.StyleCop” that you will find in the Project directory that contains *.csproj file.

open it in any Editor, Here you can find Category Id and RuleId of all the Rules.

Below is the complete list of the Rules. AnalyzerId is the CategoryId

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

False

</StyleCopSettings>
This article is part of the GWB Archives. Original Author: kazim sardar mehdi

New on Geeks with Blogs

  • We Won The One Award I Actually Care About

    Full Scale made the Inc. 5000 for the fifth year straight, the 12th listing across my three companies. Here is why the one award you cannot buy is worth stopping for.

  • Your Customers Build the Features Now

    I let a tool I liked sit dead for a year rather than build the features I wanted. An MCP server meant I never had to, and your customers can do the same to your product.

  • Get the Size of a Directory in Linux the Easy Way

    du -sh for the quick answer, ncdu for the cleanup, df for the disk itself: every command for checking directory size in Linux, plus why du and df never agree.

  • Vim Search and Replace: The Ultimate Guide

    One :%s command replaces every match in a file before a find dialog would even open. The Vim substitute patterns worth the muscle memory: flags, ranges, capture groups, and multi-file edits.