CA1717: Tylko wyliczenia FlagsAttribute powinny mieć nazwy w liczbie mnogiej
TypeName |
OnlyFlagsEnumsShouldHavePluralNames |
CheckId |
CA1717 |
Kategoria |
Microsoft.Naming |
Złamanie zmiany |
Złamanie |
Przyczyna
Nazwa wyliczenie widoczne z zewnątrz kończy się w liczbie mnogiej programu word i wyliczania nie jest oznaczony atrybutem System.FlagsAttribute atrybut.
Opis reguły
Konwencje nazewnictwa dyktować mnogiej nazwa wyliczenie wskazuje, że więcej niż jedną wartość wyliczania można określić jednocześnie.FlagsAttribute Kompilatory informuje, że wyliczenia powinny być traktowane jako pole bitowe, który umożliwia bitowe operacji na wyliczenie.
Jeśli tylko jedna z wartości wyliczenia można określić w czasie, nazwę wyliczenia powinny być pojedynczych programu word.Na przykład wyliczenie, który określa dni tygodnia, może być przeznaczona do użycia w aplikacji, gdzie można określić wiele dni.To wyliczenie powinny mieć FlagsAttribute i może być wywoływana "Dni".Wyliczanie podobne, umożliwiający ma być określony tylko jeden dzień nie miałoby atrybutu i może być nazywany "Dzień".
Konwencje nazewnictwa przewidują wspólne wygląd biblioteki docelowej aparatu plików wykonywalnych języka wspólnego.Zmniejsza to czas, który jest wymagany, aby dowiedzieć się, Nowa biblioteka oprogramowania i zaufanie klientów, że biblioteka została opracowana przez osobę, która ma doświadczenie w kodzie zarządzanym rozwijających się zwiększa.
Jak naprawić naruszenia
Zmienić nazwę wyliczenia pojedynczych programu word lub dodać FlagsAttribute.
Kiedy do pomijania ostrzeżenia
Bezpiecznie pomija ostrzeżenia, z reguły, jeśli nazwa kończy się w liczbie pojedynczej programu word.
Zasady pokrewne
CA1714: Wyliczenia flag powinny mieć nazwy w liczbie mnogiej
CA1027: Znak wyliczenia z FlagsAttribute
CA2217: Nie należy oznaczać wyliczenia z FlagsAttribute