CA1710: Identyfikatory powinny mieć poprawny przyrostek

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA1710
Tytuł Identyfikatory powinny mieć poprawny sufiks
Kategoria Nazewnictwo
Poprawka powodująca niezgodność lub niezgodność Kluczowa
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Identyfikator nie ma poprawnego sufiksu.

Domyślnie ta reguła analizuje tylko widoczne zewnętrznie identyfikatory, ale jest to możliwe do skonfigurowania.

Opis reguły

Zgodnie z konwencją nazwy typów, które rozszerzają niektóre typy podstawowe lub implementują niektóre interfejsy lub typy pochodzące z tych typów, mają sufiks skojarzony z typem podstawowym lub interfejsem.

Konwencje nazewnictwa zapewniają wspólny wygląd bibliotek przeznaczonych dla środowiska uruchomieniowego języka wspólnego. Zmniejsza to krzywą uczenia wymaganą dla nowych bibliotek oprogramowania i zwiększa pewność klienta, że biblioteka została opracowana przez kogoś, kto ma doświadczenie w tworzeniu kodu zarządzanego.

W poniższej tabeli wymieniono typy podstawowe i interfejsy, które mają skojarzone sufiksy.

Typ/interfejs podstawowy Sufiks
System.Attribute Atrybut
System.EventArgs Eventargs
System.Exception Wyjątek
System.Collections.ICollection Kolekcja
System.Collections.IDictionary Słownik
System.Collections.IEnumerable Kolekcja
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue> Słownik
System.Collections.Queue Kolekcja lub kolejka
System.Collections.Stack Kolekcja lub stos
System.Collections.Generic.ICollection<T> Kolekcja
System.Collections.Generic.IDictionary<TKey,TValue> Słownik
System.Data.DataSet DataSet
System.Data.DataTable Zbieranie lub tabela danych
System.IO.Stream Stream
System.Security.IPermission Uprawnienie
System.Security.Policy.IMembershipCondition Stan
Delegat programu obsługi zdarzeń. Eventhandler

Typy implementujące ICollection i są uogólnianym typem struktury danych, takim jak słownik, stos lub kolejka, są dozwolone nazwy, które dostarczają znaczących informacji o zamierzonym użyciu typu.

Typy, które implementują ICollection i są kolekcją określonych elementów, mają nazwy, które kończą się wyrazem "Kolekcja". Na przykład kolekcja Queue obiektów będzie miała nazwę "QueueCollection". Sufiks "Kolekcja" oznacza, że elementy członkowskie kolekcji można wyliczyć przy użyciu foreach instrukcji (For Each w Visual Basic).

Typy, które implementują IDictionary lub IReadOnlyDictionary<TKey,TValue> mają nazwy kończące się słowem "Słownik", nawet jeśli typ również implementuje IEnumerable lub ICollection. Konwencje nazewnictwa sufiksów "Kolekcja" i "Słownik" umożliwiają użytkownikom rozróżnienie między następującymi dwoma wzorcami wyliczania.

Typy z sufiksem "Kolekcja" są zgodne z tym wzorcem wyliczenia.

foreach(SomeType x in SomeCollection) { }

Typy z sufiksem "Słownik" są zgodne z tym wzorcem wyliczenia.

foreach(SomeType x in SomeDictionary.Values) { }

Obiekt DataSet składa się z kolekcji DataTable obiektów, które składają się między innymi z kolekcji System.Data.DataColumn obiektów i System.Data.DataRow . Te kolekcje implementują ICollection się za pomocą klasy bazowej System.Data.InternalDataCollectionBase .

Jak naprawić naruszenia

Zmień nazwę typu, aby był sufiksem z poprawnym terminem.

Kiedy pomijać ostrzeżenia

Można bezpiecznie pominąć ostrzeżenie, aby użyć sufiksu "Kolekcja", jeśli typ jest uogólnioną strukturą danych, którą można rozszerzyć lub które będą zawierać dowolny zestaw różnych elementów. W takim przypadku nazwa zawierająca istotne informacje o implementacji, wydajności lub innych cechach struktury danych może mieć sens (na przykład BinaryTree). W przypadkach, gdy typ reprezentuje kolekcję określonego typu (na przykład StringCollection), nie pomijaj ostrzeżenia z tej reguły, ponieważ sufiks wskazuje, że typ można wyliczyć przy użyciu foreach instrukcji .

W przypadku innych sufiksów nie pomijaj ostrzeżenia z tej reguły. Sufiks umożliwia, aby zamierzone użycie było widoczne z nazwy typu.

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 CA1710
// The code that's violating the rule is on this line.
#pragma warning restore CA1710

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

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

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

Konfigurowanie kodu do analizowania

Użyj poniższych opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.

Możesz skonfigurować te opcje 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órych częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. 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

Wykluczanie typów baz pośrednich

Możesz skonfigurować, czy z reguły mają być wykluczone pośrednie typy podstawowe. Domyślnie ta opcja jest ustawiona na wartość true, co ogranicza analizę do bieżącego typu podstawowego.

dotnet_code_quality.CA1710.exclude_indirect_base_types = false

Dodatkowe wymagane sufiksy

Możesz podać dodatkowe wymagane sufiksy lub zastąpić zachowanie niektórych zakodowanych na stałe sufiksów, dodając następującą parę klucz-wartość do pliku .editorconfig w projekcie:

dotnet_code_quality.CA1710.additional_required_suffixes = [type]->[suffix]

Oddzielaj wiele wartości znakiem | . Typy można określić w jednym z następujących formatów:

  • Nazwa typu (zawiera tylko wszystkie typy o nazwie, niezależnie od typu zawierającego lub przestrzeni nazw).
  • W pełni kwalifikowane nazwy w formacie identyfikatora dokumentacji symbolu z opcjonalnym T: prefiksem.

Przykłady:

Wartość opcji Podsumowanie
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class Wszystkie typy dziedziczone z klasy "MyClass" muszą mieć sufiks "Klasa".
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class|MyNamespace.IPath->Path Wszystkie typy dziedziczone z klasy "MyClass" muszą mieć sufiks "Class" i wszystkie typy, które implementują "MyNamespace.IPath", muszą mieć sufiks "Ścieżka".
dotnet_code_quality.CA1710.additional_required_suffixes = T:System.Data.IDataReader->{} Zastępuje wbudowane sufiksy. W takim przypadku wszystkie typy implementujące "IDataReader" nie są już wymagane do zakończenia elementu "Kolekcja".

CA1711: Identyfikatory nie powinny mieć niepoprawnego sufiksu

Zobacz też