Udostępnij za pomocą

CA1711: Identyfikatory nie powinny mieć niepoprawnego przyrostka

Własność Wartość
Identyfikator reguły CA1711
Tytuł Identyfikatory nie powinny mieć nieprawidłowych sufiksów
Kategoria Nazewnictwo
Poprawka jest niszcząca lub nieniszcząca Kluczowa
Domyślnie włączone na platformie .NET 10 Nie.

Przyczyna

Identyfikator ma niepoprawny sufiks.

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ą określone typy podstawowe lub implementują określone interfejsy lub typy pochodzące z tych typów, powinny kończyć się określonymi sufiksami zarezerwowanymi. Inne nazwy typów nie powinny używać tych zarezerwowanych sufiksów.

W poniższej tabeli wymieniono zastrzeżone sufiksy oraz podstawowe typy i interfejsy, z którymi są skojarzone.

Przyrostek Typ/interfejs podstawowy
Attribute System.Attribute
Collection System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
Dictionary System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
EventArgs System.EventArgs
EventHandler Delegat programu obsługi zdarzeń
Exception System.Exception
Permission System.Security.IPermission
Queue System.Collections.Queue
Stack System.Collections.Stack
Stream System.IO.Stream

Ponadto nie należy używać następujących sufiksów:

  • Delegate
  • Enum
  • Ex lub podobny sufiks, aby odróżnić go od starszej wersji tego samego typu
  • Flag lub Flags dla typów wyliczenia
  • Impl (użyj Core zamiast tego)
  • New, jeśli członek o tej samej nazwie, ale bez sufiksu New już istnieje

Konwencje nazewnictwa zapewniają typowy wygląd bibliotek przeznaczonych dla środowiska uruchomieniowego języka wspólnego platformy .NET. Te konwencje zmniejszają krzywą uczenia wymaganą dla nowych bibliotek oprogramowania i zwiększają zaufanie klientów, że biblioteka została opracowana przez kogoś z doświadczeniem w tworzeniu kodu zarządzanego. Aby uzyskać więcej informacji, zobacz Wytyczne dotyczące nazewnictwa: Klasy, struktury i interfejsy.

Jak naprawić naruszenia

Usuń sufiks z nazwy typu.

Example

class BadEmployeeCollection { } // Violates CA1711

// Good
class Employee { }
class GoodEmployeeCollection : ICollection<Employee>
{
    // Implementations
}

class Employees { } // Good

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżenia z tej reguły, chyba że sufiks ma jednoznaczne znaczenie w domenie aplikacji.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1711.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ć, na które części bazy kodu ma być zastosowana ta reguła.

Można skonfigurować te opcje tylko dla tej reguły, dla wszystkich reguł, do których mają zastosowanie, lub dla wszystkich reguł w tej kategorii (nazewnictwo), do których mają zastosowanie. 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ć zastosowana ta reguła, na podstawie ich dostępności, 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.

Zezwalaj na sufiksy

Możesz skonfigurować listę dozwolonych sufiksów, z każdym sufiksem oddzielonym pionową kreską ("|"). Aby na przykład określić, że reguła nie powinna być uruchamiana względem sufiksów Flag i Flags, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

Zobacz też

  • Last updated on