Menu
When breaking out classes into files, I am wondering what the naming convention is for class files containing only enums. Should they match the enum name, like any other class, or should they be suffixed with 'Enum' so that the developer knows that the file contains only an enum?
For example:
namespace MyCompanyName.MyApplication
{
public enum Colors
{
Red,
Blue,
Green,
Yellow
}
}
Would you say the file containing the above code should be named 'Colors.cs' or 'ColorsEnum.cs'? Alternatively, perhaps there is another accepted naming convention for such files?
614
Use a singular name for most Enum types, but use a plural name for Enum types that are bit fields. With the note that bit fields should be pluralized.
Enums are types, so they should be named using UpperCamelCase like classes. The enum values are constants, so they should be named using lowerCamelCase like constants, or ALL_CAPS if your code uses that legacy naming style.
Enums in Java (and probably enums in general) should be singular. The thinking is that you're not selecting multiple Protocols, but rather one Protocol of the possible choices in the list of values.
The enum value BAD resides in the general identifier scope, while the class type BAR resides in the class identifier scope. That is the reason why you are allowed to have both an enum value and a class with the same name: both names do not collide.
First off, this is a complete personal/team preference thing.
That being said:
I personally would name it Colors.cs. This keeps the filename corresponding to the type name. When I'm working on the API, if "Colors" are a fixed set of things represented by an enum, I'd probably know that, and there would be no confusion.
177
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
