CA1714: Flags enums should have plural names
TypeName |
FlagsEnumsShouldHavePluralNames |
CheckId |
CA1714 |
Category |
Microsoft.Naming |
Breaking Change |
Breaking |
Cause
A public enumeration has the System.FlagsAttribute and its name does not end in 's'.
Rule Description
Types that are marked with FlagsAttribute have names that are plural because the attribute indicates that more than one value can be specified. For example, an enumeration that defines the days of the week might be intended for use in an application where you can specify multiple days. This enumeration should have the FlagsAttribute and could be called 'Days'. A similar enumeration that allows only a single day to be specified would not have the attribute, and could be called 'Day'.
Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve that is required for new software libraries, and increases customer confidence that the library was developed by someone who has expertise in developing managed code.
How to Fix Violations
Make the name of the enumeration a plural word, or remove the FlagsAttribute attribute if multiple enumeration values should not be specified simultaneously.
When to Suppress Warnings
It is safe to suppress a violation if the name is a plural word but does not end in 's'. For example, if the multiple-day enumeration that was described previously were named 'DaysOfTheWeek', this would violate the logic of the rule but not its intent. Such violations should be suppressd.
Related Rules
CA1027: Mark enums with FlagsAttribute
CA2217: Do not mark enums with FlagsAttribute