Can I suppress all code analysis messages for a certain class?

Question

Whenever I call my logger in a method, e.g.

_logger.Debug("Connecting to database...");

I get the warning:

CA1303 : Microsoft.Globalization: 
Method 'Database.Connect()' passes a literal 
string as parameter  'message' of a call to 'ILogger.Debug(string)'. 
Retrieve the following string(s) from a resource table instead: 
"Connecting to database...".

Is there a way to suppress this warning every time I use a function of ILogger? I really don't want to suppress it in every method I'm using it.

Or, you could get the string from a resource table instead and then you won't have any warnings anymore? — Msonic, Mar 26 '12 at 13:41
Prefix the string with @ to mark it as a literal, .Debug(@"Connecting to database...") — Andy Baker, Oct 07 '16 at 14:31

score 15 · Answer 1 · answered Mar 25 '14 at 20:21

15

If you control the ILogger interface, you can leverage the Localizable attribute with a value of false to indicate the value is not localizable.

For example:

void Info([Localizable(false)] string message);

answered Mar 25 '14 at 20:21

John Koerner

37,428
8
84
134

1

Exactly what was needed. Should have been marked as an answer. – Alex M Dec 14 '14 at 16:27

score 3 · Answer 2 · answered Mar 26 '13 at 02:12

3

I ran into this issue and found that the easiest solution was to rename my logging method's parameter from "message" to something else.

CA1303 will only trigger if the relevant parameter or property name contains "Text", "Message" or "Caption". If the parameter is passed to Console.Write or Console.WriteLine, the parameter also cannot be named "value" or "format".

answered Mar 26 '13 at 02:12

halter73

15,059
3
49
60

Thanks. While I think the proper solution is to use `[Localizable(false)]`, System.ComponentModel.LocalizableAttribute is unfortunately not available in Portable Class Libraries. So for me changing the parameter name from `message` to `logMsg` solved it (then I just had to suppress CA1704:IdentifiersShouldBeSpelledCorrectly in the log interface). – hlovdal Jan 28 '15 at 15:30

score 3 · Accepted Answer · answered Mar 27 '12 at 12:25

Neither FxCop/VS Code Analysis nor the CA1303 rule are configurable to ignore particular targets in this way. You basically have three options:

Suppress the violations individually,
Disable the rule, or
Substitute a custom rule that behaves the way you would prefer.

I tend to lean toward #3 for this sort of thing, but ymmv... Also, if you feel strongly that you ought to be able to control the CA1303 behaviour, this is something to consider requesting at https://connect.microsoft.com/VisualStudio or http://visualstudio.uservoice.com/forums/121579-visual-studio.

score 2 · Answer 4 · answered Sep 19 '12 at 21:30

2

If you apply the GeneratedCode attribute to a class, Code Analysis will not analyze your class.

answered Sep 19 '12 at 21:30

Evan Machusak

694
4
9

Can I suppress all code analysis messages for a certain class?

4 Answers4