CA1717: Pouze výčty FlagsAttribute by měly mít názvy v množném čísle
Název_typu |
OnlyFlagsEnumsShouldHavePluralNames |
CheckId |
CA1717 |
Kategorie |
Microsoft.Naming |
Změnit rozdělení |
Rozdělení |
Příčina
Název výčtu externě viditelné končí v množném čísle word a výčtu není označeno FlagsAttribute atributu.
Popis pravidla
Konvence diktovat množném čísle název výčtu označuje, že je současně zadán více než jednou hodnotou výčtu.FlagsAttribute Kompilátory říká, že výčet by měly být považovány za bitové pole, který umožňuje bitové operace výčtu.
Pokud pouze jedna hodnota výčtu lze současně, musí být název výčtu singulární slova.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 dobu, po kterou je nutné naučit 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í
Nastavit název výčtu singulární slova nebo přidat FlagsAttribute.
Při potlačení upozornění
Je bezpečné potlačit varování z pravidla, pokud název končí v jednotném word.
Souvisejících pravidel
CA1714: Výčty příznaků by neměly mít názvy v množném čísle
CA1027: Označte výčty pomocí FlagsAttribute
CA2217: Neoznačujte výčty pomocí FlagsAttribute