CA1717: Tylko typy wyliczeniowe FlagsAttribute powinny mieć nazwy w liczbie mnogiej

Właściwości Wartość
Identyfikator reguły CA1717
Tytuł Tylko wyliczenia z atrybutem Flags powinny mieć nazwy w liczbie mnogiej
Kategoria Nazewnictwo
Poprawka łamiąca lub nienaruszająca Przełomowe
Domyślnie włączone na platformie .NET 10 Nie.
Zastosowane języki C# i Visual Basic

Przyczyna

Nazwa wyliczenia kończy się liczbą mnogą, a wyliczenie nie jest oznaczone atrybutem System.FlagsAttribute .

Domyślnie ta reguła analizuje tylko widoczne zewnętrznie wyliczenia, ale można to skonfigurować.

Opis reguły

Konwencje nazewnictwa określają, że nazwa w liczbie mnogiej dla wyliczenia wskazuje na możliwość jednoczesnego określenia więcej niż jednej wartości wyliczenia. Instrukcja FlagsAttribute informuje kompilatory, że wyliczenie powinno być traktowane jako obszar bitowy, który umożliwia wykonywanie operacji bitowych na wyliczeniu.

Jeśli jednocześnie można określić tylko jedną wartość wyliczenia, nazwa wyliczenia powinna być słowem pojedynczym. Na przykład wyliczenie, które definiuje dni tygodnia, może być przeznaczone do użycia w aplikacji, w której można określić wiele dni. To wyliczenie powinno mieć wartość FlagsAttribute i może mieć nazwę "Days". Podobne wyliczenie, które umożliwia określenie tylko jednego dnia, nie będzie miało atrybutu i może być nazywane "Dzień".

Konwencje nazewnictwa zapewniają spójny format dla bibliotek działających w środowisku uruchomieniowym języka wspólnego. Skraca to czas wymagany do nauki nowej biblioteki oprogramowania i zwiększa pewność klienta, że biblioteka została opracowana przez kogoś, kto ma doświadczenie w tworzeniu kodu zarządzanego.

Jak naprawić naruszenia

Zmień nazwę wyliczenia na pojedyncze słowo albo dodaj FlagsAttribute.

Kiedy pomijać ostrzeżenia

Można bezpiecznie pominąć ostrzeżenie reguły, jeśli nazwa kończy się pojedynczym słowem.

Pomijanie ostrzeżenia

Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

#pragma warning disable CA1717
// The code that's violating the rule is on this line.
#pragma warning restore CA1717

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

[*.{cs,vb}]
dotnet_diagnostic.CA1717.severity = none

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części kodu mają być objęte tą regułą.

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (nazewnictwo), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Uwzględnij określone powierzchnie interfejsu API

Możesz skonfigurować, na które części bazy kodu ma być stosowana ta reguła, na podstawie ich poziomu dostępu, ustawiając opcję api_surface. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Notatka

Zastąp część XXXXCAXXXX identyfikatorem odpowiedniej reguły.

Zobacz też

  • Last updated on