SuppressMessage for all enum members. | Tech Off

Bas
It finds lightbulbs.

I have an enum that FxCop happens to be bugging me about (it's an IdentifiersShouldBeSpelledCorrectly warning), and I actually have good reason to name them as such, so I figured I'd suppress those warnings explicitly in code. However, the only way to do so as far as I can find is to add a SuppressMessage attribute to each member in the enum, which makes the whole thing practically unreadable. Is there any way to tell FxCop to just ignore the IdentifiersShouldBeSpelledCorrectly warning for every member in a certain enumeration?

Sven Groot
My name has 9 letters. Coincidence? I think not...

How about adding the names of the identifiers to the custom dictionary for the project?

Bas
It finds lightbulbs.

In reply to Sven Groot

#Jul 4th @ 7:15 AM

Oh hey, that's also not a bad idea. Thanks.

W3bbo
The Master of Baiters

In reply to Bas

#Jul 4th @ 7:27 AM

Or mark the Fxcop messages as Excluded?

I'm not a fan of using attributes like this since, as you say, it makes the code messy.

Bas
It finds lightbulbs.

In reply to W3bbo

#Jul 4th @ 9:35 AM

Yeah, I thought about doing it in FxCop, but I liked the idea of the code making it clear that the enum members were definitely named that way for a reason.

W3bbo
The Master of Baiters

In reply to Bas

#Jul 4th @ 9:45 AM

That's what comments are for Smiley

Whilst we're on the subject, I hate having to put Enum member info on their own line in <summary> blocks. I'd prefer it if the C# documentation generator did a similar thing to the C++ doc generator and include // comments made on the same line as the member.

So rather than:

public enum Foo {
    /// <summary>Some member (0xFF)</summary>
    Bar = 0xFF,
    Baz,
}

You can do this:

public enum Foo {
Bar = 0xFF, // Some member
Baz,
}

I'd also like it if intellisense showed you the numeric value of an enum member rather than having to put a copy in the <summary> comment.

Bas
It finds lightbulbs.

In reply to W3bbo

#Jul 4th @ 3:39 PM

That bugs me too. Anything that makes you put stuff between the members (like summaries or SuppressMessageAttributes) instantly makes the enum annoying to read.

With regards to numerical values: that always felt dodgy to me, for reasons I can't quite put my finger on. I don't know why, but for some reason it feels wrong to not treat the internal value (and type) as anything other than an internal representation of the enum.

That doesn't stop me from doing it, but it still feels wrong.