CA1058: Typy by neměly rozšířit určité základní typy

Vlastnost Hodnota
ID pravidla CA1058
Název Typy by neměly rozšiřovat určité základní typy
Kategorie Návrh
Oprava, která může být destruktivní nebo nedestruktivní Přerušující
Povoleno ve výchozím nastavení v .NET 10 Ne
Příslušné jazyky C# a Visual Basic

Příčina

Typ rozšiřuje jeden z následujících základních typů:

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

Popis pravidla

Výjimky by měly být odvozeny z System.Exception nebo jedné z jejích podtříd v oboru názvů System.

Nevytvádřujte podtřídu XmlDocument , pokud chcete vytvořit zobrazení XML podkladového objektového modelu nebo zdroje dat.

Ne generické kolekce

Pokud je to možné, používejte nebo rozšiřte obecné kolekce. Neprodlužujte v kódu jiné než obecné kolekce, pokud jste je již dříve nedodali.

Příklady nesprávného použití

public class MyCollection : CollectionBase
{
}

public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}

Příklady správného použití

public class MyCollection : Collection<T>
{
}

public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}

Jak opravit porušení

Chcete-li opravit porušení tohoto pravidla, odvoďte typ z jiného základního typu nebo obecné kolekce.

Kdy potlačit upozornění

Nepotlačujte upozornění z tohoto pravidla pro porušení týkající se ApplicationException. Je bezpečné potlačit upozornění z tohoto pravidla týkající se porušení o XmlDocument. Pokud byl kód vydán dříve, je bezpečné potlačit upozornění na negenerickou kolekci.

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

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.CA1058.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

Nastavením možnosti api_surface můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět na základě jejich přístupnosti. 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

Poznámka

Nahraďte XXXX část CAXXXX ID příslušného pravidla.

  • Last updated on