CA1005: Unikaj nadużywania parametrów na typach generycznych

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA1005
Stanowisko Unikaj nadmiernego użycia parametrów w typach ogólnych
Kategoria Projekt
Poprawka powodująca niezgodność lub niezgodność Kluczowa
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Zewnętrznie widoczny typ ogólny ma więcej niż dwa parametry typu.

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

Opis reguły

Im więcej parametrów typu zawiera typ ogólny, tym trudniej poznać i zapamiętać, co reprezentuje każdy z nich. Zwykle jest to oczywiste z jednym parametrem typu, jak w List<T>, i w niektórych przypadkach z dwoma parametrami typu, jak w .Dictionary<TKey, TValue> Jeśli istnieje więcej niż dwa parametry typu, trudność staje się zbyt duża dla większości użytkowników (na przykład TooManyTypeParameters<T, K, V> w języku C# lub TooManyTypeParameters(Of T, K, V) Visual Basic).

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, zmień projekt tak, aby używał nie więcej niż dwóch parametrów typu.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżenia z tej reguły, chyba że projekt absolutnie wymaga więcej niż dwóch parametrów typu. Udostępnianie typów ogólnych w składni, która jest łatwa do zrozumienia i używania skraca czas wymagany do nauki i zwiększa szybkość wdrażania nowych bibliotek.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1005.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 bazy kodu mają być uruchamiane w tej regule.

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 (Projekt), 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

CA1010: Kolekcje powinny implementować interfejs ogólny

CA1000: Nie deklaruj składowych statycznych w typach ogólnych

CA1002: Nie ujawniaj list ogólnych

CA1003: Użyj wystąpień ogólnej procedury obsługi zdarzeń

Zobacz też