CA1714: имена перечислений флагов должны быть во множественном числе
TypeName |
FlagsEnumsShouldHavePluralNames |
CheckId |
CA1714 |
Категория |
Microsoft.Naming |
Критическое изменение |
Критическое изменение |
Причина
Открытое перечисление содержит атрибут FlagsAttribute, однако имя перечисления не заканчивается на "s".
Описание правила
Имена типов, помеченных атрибутом FlagsAttribute, используются во множественном числе, поскольку данный атрибут указывает на возможность задания нескольких значений.Например, перечисление, определяющее дни недели, может быть предназначено для приложения, в котором указывается несколько дней.Это перечисление следует пометить атрибутом FlagsAttribute и присвоить ему имя "Days".Похожее перечисление, которое позволяет указать только один день, не будет помечено данным атрибутом, и его можно назвать "Day".
Соглашения об именах обеспечивают единообразие библиотек, предназначенных для выполнения в среде CLR.Это позволяет сократить время обучения, необходимое для освоения новых библиотек программного обеспечения, и укрепить уверенность клиента в том, что библиотека была разработана опытным разработчиком управляемого кода.
Устранение нарушений
Задайте перечислению имя во множественном числе или, если одновременный выбор нескольких значений перечисления не предусмотрен, удалите атрибут FlagsAttribute.
Отключение предупреждений
Если имя перечисления указано во множественном числе, но не оканчивается на "s", данное предупреждение можно отключить.Например, если описанному ранее перечислению с возможностью указать несколько дней недели присвоено имя "DaysOfTheWeek", данное слово формально нарушает правило, но удовлетворяет его смыслу.Подобные нарушения следует отключать.
Связанные правила
CA1027: следует помечать перечисления атрибутом FlagsAttribute
CA2217: не следует помечать перечисления атрибутом FlagsAttribute