Sdílet prostřednictvím

CA1005: Vyhněte se nadbytečným parametrům na obecných typech

  • Článek
Vlastnost Hodnota
ID pravidla CA1005
Název Vyhněte se nadbytečným parametrům u obecných typů
Kategorie Návrh
Oprava způsobující chybu nebo chybu způsobující chybu Narušující
Povoleno ve výchozím nastavení v .NET 8 No

Příčina

Externě viditelný obecný typ má více než dva parametry typu.

Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné typy, ale dá se konfigurovat.

Popis pravidla

Čím více parametrů typu obecný typ obsahuje, tím obtížnější je vědět a zapamatovat si, co každý z parametrů typu představuje. Obvykle je zřejmé, že s jedním parametrem typu, jako v List<T>, a v některých případech se dvěma parametry typu, jako v Dictionary<TKey, TValue>. Pokud existuje více než dva parametry typu, je obtížné pro většinu uživatelů příliš velké (například TooManyTypeParameters<T, K, V> v jazyce C# nebo TooManyTypeParameters(Of T, K, V) v jazyce Visual Basic).

Jak opravit porušení

Chcete-li opravit porušení tohoto pravidla, změňte návrh tak, aby používal maximálně dva parametry typu.

Kdy potlačit upozornění

Nepotlačujte upozornění z tohoto pravidla, pokud návrh nevyžaduje více než dva parametry typu. Poskytnutí obecných typů v syntaxi, která je snadno pochopitelná a využitá, zkracuje dobu potřebnou k učení a zvyšuje míru přijetí nových knihoven.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

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

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.

Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (Návrh), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

Zahrnutí konkrétních povrchů rozhraní API

Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CAXXXX.api_surface = private, internal

CA1010: Kolekce musí implementovat obecné rozhraní

CA1000: Nedeklarujte statické členy v obecných typech

CA1002: Nezveřejňujte obecné seznamy

CA1003: Použijte instance obecných obslužných rutin události

Viz také