Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Enum and property naming conflicts

Tags:

c#

.net

When using a class that has an enum property, one usually gets a naming conflict between the property name and the enum type. Example:

enum Day{ Monday, Tuesday, ... }  class MyDateClass {    private Day day;     public Day Day{ get{ return day; } } } 

Since only flags enums should have plural names, naming the enum "Days" is not the way to go for a non-flag enum. In the above example you could use some variation like "WeekDay" for either the enum or the property. But in the general case there are no good variations like that so you end up using properties like "FooMode" or "BarKind" for an object with enum properties of Foo and Bar type. Not so elegant.

How do you usually name enums and properties in this scenario?


Thanks for the quick responses. Another question: why is it not recommended to nest public enums, and how do you resolve the naming issues if you want to nest public enums?

class Vehicle {   enum Kind{ Car, Bike }    public Kind Kind{ get{ return ... } } }  class Meal {   enum Kind{ Dessert, MainCourse }    public Kind Kind{ get{ return ... } } } 

In the scenario above, given that Meal and Vehicle share the same namespace, I can't move "Kind" outside either of the classes without renaming it MealKind and VehicleKind respectively. I like the look of

myVehicle.Kind = Vehicle.Kind.Car 

But that is not what the guidlines recommend. What would be the best practice here? Never to use nested public enums and instead name them VehicleKind etc.?

like image 966
AndersF Avatar asked Oct 17 '08 09:10

AndersF


1 Answers

There is no conflict. In fact, the .NET Framework style guide encourages you to do this, e.g. if you have a class that has a single property of a type (no matter if enum or class), then you should name it the same. Typical example is a Color property of type Color. It's fine, unless there are two colors - in that case both should add something to the name (i.e. BackColor and ForeColor, instead of Color and BackColor).

like image 54
OregonGhost Avatar answered Oct 02 '22 07:10

OregonGhost