Comment Feed for SuppressMessage for all enum members. (TechOff on Channel 9)

Re: Re: Re: Re: Re: Re: SuppressMessage for all enum members.

Bas — Sat, 04 Jul 2009 22:59:10 GMT

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.

Re: Re: Re: Re: Re: SuppressMessage for all enum members.

W3bbo — Sat, 04 Jul 2009 22:39:53 GMT

That's what comments are for :)

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.

Re: Re: Re: Re: SuppressMessage for all enum members.

Bas — Sat, 04 Jul 2009 16:45:13 GMT

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.

Re: Re: Re: SuppressMessage for all enum members.

W3bbo — Sat, 04 Jul 2009 16:35:20 GMT

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.

Re: Re: SuppressMessage for all enum members.

Bas — Sat, 04 Jul 2009 14:27:19 GMT

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

Re: SuppressMessage for all enum members.

Sven Groot — Sat, 04 Jul 2009 14:15:03 GMT

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