CODEWITHSUNDEEP
.netstylecop
stiank81
stiank81

Reputation: 25686

Disable StyleCop for specific lines

We're using StyleCop in our C# projects. In some cases we'd like to avoid the rules though. I know you can add // <auto-generated /> in the beginning of the file to make StyleCop ignore it. However, I don't want to ignore the rules for the whole file - only a block of code within it.

Can I disable StyleCop for specific lines somehow?

Upvotes: 38

Views: 18962

Answers (6)

Appetere
Appetere

Reputation: 6261

You can disable a block of code like so:

// some other code before and after

#pragma warning disable SA1008 // Opening parenthesis must not be preceded by a space
     (_, value) => (key, value)))
#pragma warning restore SA1008

Upvotes: 0

jezzipin
jezzipin

Reputation: 4244

Decorate your class or method with the following StyleCop attribute:

[GeneratedCode("Tool Goes Here", "Message Goes Here")]

Upvotes: 0

sGambolati
sGambolati

Reputation: 782

You can put the piece of code between a region name Generated Code and it will be ommited.

Upvotes: 0

Adam Butler
Adam Butler

Reputation: 3037

An old question I know but in looking for an answer I found that in stylecop 4.4 you can now put something like this - or one of these lines on a method:

[SuppressMessage("Microsoft.StyleCop.CSharp.DocumentationRules", "*", Justification = "Risky to change manually")]
[SuppressMessage("Microsoft.StyleCop.CSharp.SpacingRules", "*", Justification = "Risky to change manually")]
[SuppressMessage("Microsoft.StyleCop.CSharp.MaintainabilityRules", "*", Justification = "Risky to change manually")]
[SuppressMessage("Microsoft.StyleCop.CSharp.LayoutRules", "*", Justification = "Risky to change manually")]
[SuppressMessage("Microsoft.StyleCop.CSharp.NamingRules", "*", Justification = "Risky to change manually")]
[SuppressMessage("Microsoft.StyleCop.CSharp.ReadabilityRules‌​", "*", Justification = "Risky to change manually")]
[SuppressMessage("Microsoft.StyleCop.CSharp.OrderingRules", "*", Justification = "Risky to change manually")]
  • Note: I might be missing one or two of the rule categories

Upvotes: 13

satnhak
satnhak

Reputation: 9861

This guy seems to have a good general ignore hack; he suggests putting this at the top of the file - tested and working with R#

//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
// </auto-generated>
//------------------------------------------------------------------------------

Handy for when you are just churning out a load of boilerplate to adhere to a mainly unimplemented interface, for example.

Upvotes: 6

FinnNk
FinnNk

Reputation: 3275

You can suppress rules by adding attributes to blocks of code. Here's a simple example on a class from the blog post linked below, but you can do it on various members individually:

[SuppressMessage("Microsoft.StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
public class MyUndocumentedClass
{
    public void MyUndocumentedMethod {}
}

There's a quick overview at an MSDN blog post and a fuller description of the attributes on MSDN.

Upvotes: 37

Related Questions