CA1717: Only FlagsAttribute enums should have plural names
Note
This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here
| Item | Value |
|---|---|
| TypeName | OnlyFlagsEnumsShouldHavePluralNames |
| CheckId | CA1717 |
| Category | Microsoft.Naming |
| Breaking Change | Breaking |
Cause
The name of an externally visible enumeration ends in a plural word and the enumeration is not marked with the System.FlagsAttribute attribute.
Rule Description
Naming conventions dictate that a plural name for an enumeration indicates that more than one value of the enumeration can be specified simultaneously. The FlagsAttribute tells compilers that the enumeration should be treated as a bit field that enables bitwise operations on the enumeration.
If only one value of an enumeration can be specified at a time, the name of the enumeration should be a singular word. 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 time that is required to learn a new software library, 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 singular word or add the FlagsAttribute.
When to Suppress Warnings
It is safe to suppress a warning from the rule if the name ends in a singular word.
Related Rules
CA1714: Flags enums should have plural names
CA1027: Mark enums with FlagsAttribute
CA2217: Do not mark enums with FlagsAttribute