I often find myself implementing a class maintaining some kind of own status property as an enum: I have a Status enum and ONE Status property of Status type. How should I solve this name conflict?
public class Car { public enum Status { Off, Starting, Moving }; Status status = Status.Off; public Status Status // <===== Won't compile ===== { get { return status; } set { status = value; DoSomething(); } } }
If the Status enum were common to different types, I’d put it outside the class and the problem would be solved. But Status applies to Car only hence it doesn’t make sense to declare the enum outside the class.
What naming convention do you use in this case?
NB: This question was partially debated in comments of an answer of this question. Since it wasn’t the main question, it didn’t get much visibility.
EDIT: Filip Ekberg suggests an IMO excellent workaround for the specific case of ‘Status’. Yet I’d be interesting to read about solutions where the name of the enum/property is different, as in Michael Prewecki’s answer.
EDIT2 (May 2010): My favorite solution is to pluralize the enum type name, as suggested by Chris S. According to MS guidelines, this should be used for flag enums only. But I’ve come to like it more and more. I now use it for regular enums as well.
I’ll add my 1 euro to the discussion but it’s probably not adding anything new.
The obvious solution is to move Status out of being a nested Enum. Most .NET enums (except possibly some in Windows.Forms namespace) aren’t nested and it makes it annoying to use for the developer consuming your API, having to prefix the classname.
One thing that hasn’t been mentioned is that flag enums according to MSDN guidelines should be pluralized nouns which you probably already know (Status is a simple enum so singular nouns should be used).
State (enum called States) is the vocative, ‘Status’ is the nominative of a noun that the English like most of our language absorbed from Latin. Vocative is what you name a noun for its condition and nominative is the subject of the verb.
So in other words when the car is moving, that’s the verb – moving is its status. But the car doesn’t go off, its engine does. Nor does it start, the engine does (you probably picked an example here so this might be irrelevant).
State is such a generalised noun wouldn’t it be better to describe what state it is referring to? Like I did above
The type example also in my view doesn’t refer to the reader type, but its database. I would prefer it if you were describing the reader’s database product which isn’t necessarily relevant to the type of reader (e.g. the type of reader might be forward only, cached and so on). So
In reality this never happens as they’re implemented as drivers and an inheritance chain instead of using enums which is why the line above doesn’t look natural.