CA1714: Typy wyliczeniowe flag powinny mieć nazwy w liczbie mnogiej

Artykuł
06/08/2015

TypeName	FlagsEnumsShouldHavePluralNames
CheckId	CA1714
Kategoria	Microsoft.Naming
Złamanie zmiany	Złamanie

Przyczyna

Wyliczenie publicznych ma FlagsAttribute i jego nazwa nie kończy się w 's'.

Opis reguły

Typy, które są oznaczone FlagsAttribute mają nazwy, które są mnogiej, ponieważ atrybut wskazuje, że można określić więcej niż jedną wartość.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 krzywej uczenia się, która jest wymagana dla nowych bibliotek oprogramowania i zwiększa zaufanie klientów, że biblioteka została opracowana przez osobę, która ma doświadczenie w rozwijającym się kod zarządzany.

Jak naprawić naruszenia

Wprowadź nazwę wyliczenia word mnogiej lub usunąć FlagsAttribute atrybutu, jeśli wiele wartości wyliczenia nie można określić jednocześnie.

Kiedy do pomijania ostrzeżenia

Można bezpiecznie pominąć naruszenie, jeśli nazwa jest mnogiej programu word, ale nie kończy się w 's'.Na przykład jeśli wyliczenie wielu dzień, opisane wcześniej zostały nazwane "DaysOfTheWeek", to naruszać logiki reguły, ale nie jego intencji.Te naruszenia powinny być suppressd.