CA1714: Výčty příznaků by neměly mít názvy v množném čísle
Název_typu |
FlagsEnumsShouldHavePluralNames |
CheckId |
CA1714 |
Kategorie |
Microsoft.Naming |
Změnit rozdělení |
Rozdělení |
Příčina
Veřejné výčet má FlagsAttribute a jeho název nekončí v jeho ".
Popis pravidla
Typy, které jsou označeny FlagsAttribute názvy, které jsou v množném čísle, protože atribut znamená, že lze zadat více než jednu hodnotu.Například výčet definující dny v týdnu pravděpodobně určen pro použití v aplikaci, kde můžete zadat více dní.Tento výčet by měl mít FlagsAttribute a být také dny".Podobné výčtu, který umožňuje být určen pouze jeden den nemá atribut a může být volána "Den".
Konvence stanovit společné vzhled knihovny tomuto cíli společného jazykového modulu runtime.To snižuje učení křivku, která je vyžadována pro nové knihovny softwaru a zvyšuje důvěru zákazníků, že osoba, která má odborné znalosti v rozvojových spravovaný kód byl vyvinut knihovny.
Jak opravit porušení
Vytvořit název výčtu množném čísle word nebo odebrat FlagsAttribute atributu, je-li více hodnot výčtu nelze zadat současně.
Při potlačení upozornění
Je bezpečné narušení potlačit, pokud je název množném čísle slovo ale nekončí na ".Například pokud několikadenní výčtu, která byla popsána byly dříve název "DaysOfTheWeek", toto porušení logiky pravidlo, ale není jeho záměr.Takové porušení by měly být suppressd.
Souvisejících pravidel
CA1027: Označte výčty pomocí FlagsAttribute
CA2217: Neoznačujte výčty pomocí FlagsAttribute