CA1002: Nezveřejňujte obecné seznamy
Vlastnost | Hodnota |
---|---|
ID pravidla | CA1002 |
Název | Nezveřejňujte obecné seznamy |
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 9 | No |
Příčina
Typ obsahuje externě viditelný člen, který je typem System.Collections.Generic.List<T> , vrátí List<T> typ nebo jehož podpis obsahuje List<T> parametr.
Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné typy, ale dá se konfigurovat.
Popis pravidla
System.Collections.Generic.List<T> je obecná kolekce, která je navržená pro výkon a nikoli dědičnost. List<T> neobsahuje virtuální členy, které usnadňují změnu chování zděděné třídy. Následující obecné kolekce jsou navrženy pro dědičnost a měly by být vystaveny místo List<T>.
Jak opravit porušení
Chcete-li opravit porušení tohoto pravidla, změňte System.Collections.Generic.List<T> typ na jednu z obecných kolekcí, která je navržená pro dědičnost.
Kdy potlačit upozornění
Nepotlačujte upozornění z tohoto pravidla, pokud sestavení, které toto upozornění vyvolá, není určeno jako opakovaně použitelná knihovna. Například by bylo bezpečné potlačit toto upozornění v aplikaci s vyladěným výkonem, kde se z použití obecných seznamů získala výhoda výkonu.
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 CA1002
// The code that's violating the rule is on this line.
#pragma warning restore CA1002
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.CA1002.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
Související pravidla
CA1005: Vyhněte se nadbytečným parametrům na obecných typech
CA1010: Kolekce musí implementovat obecné rozhraní
CA1000: Nedeklarujte statické členy v obecných typech
CA1003: Použijte instance obecných obslužných rutin události