CA1058: Typen mogen bepaalde basistypen niet uitbreiden

Eigenschappen	Weergegeven als
Regel-id	CA1058
Titel	Typen mogen bepaalde basistypen niet uitbreiden
Categorie	Ontwerpen
Oplossing is brekend of niet-brekend	Breken
Standaard ingeschakeld in .NET 8	Nee

Oorzaak

Een type breidt een van de volgende basistypen uit:

• System.ApplicationException
• System.Xml.XmlDocument
• System.Collections.CollectionBase
• System.Collections.DictionaryBase
• System.Collections.Queue
• System.Collections.ReadOnlyCollectionBase
• System.Collections.SortedList
• System.Collections.Stack

Deze regel kijkt standaard alleen naar extern zichtbare typen, maar dit kan worden geconfigureerd.

Beschrijving van regel

Uitzonderingen moeten zijn afgeleid van System.Exception of een van de subklassen in de System naamruimte.

Maak geen subklasse van XmlDocument als u een XML-weergave van een onderliggend objectmodel of gegevensbron wilt maken.

Niet-algemene verzamelingen

Gebruik en/of breid algemene verzamelingen indien mogelijk uit. Breid niet niet-algemene verzamelingen uit in uw code, tenzij u deze eerder hebt verzonden.

Voorbeelden van onjuist gebruik

public class MyCollection : CollectionBase
{
}

public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}

Voorbeelden van correct gebruik

public class MyCollection : Collection<T>
{
}

public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}

Schendingen oplossen

Als u een schending van deze regel wilt oplossen, moet u het type afleiden van een ander basistype of een algemene verzameling.

Wanneer waarschuwingen onderdrukken

Geen waarschuwing van deze regel onderdrukken voor schendingen over ApplicationException. Het is veilig om een waarschuwing van deze regel te onderdrukken voor schendingen over XmlDocument. Het is veilig om een waarschuwing over een niet-algemene verzameling te onderdrukken als de code eerder is uitgebracht.

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

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

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.

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

Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.

Code configureren om te analyseren

Gebruik de volgende optie om te configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd.

• Specifieke API-oppervlakken opnemen

U kunt deze optie configureren voor alleen deze regel, voor alle regels waarop deze van toepassing is, of voor alle regels in deze categorie (ontwerp) waarop deze van toepassing is. Zie de configuratieopties voor de codekwaliteitsregel voor meer informatie.

Specifieke API-oppervlakken opnemen

U kunt instellen op welke onderdelen van uw codebase deze regel moet worden uitgevoerd, op basis van hun toegankelijkheid. Als u bijvoorbeeld wilt opgeven dat de regel alleen moet worden uitgevoerd op het niet-openbare API-oppervlak, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CAXXXX.api_surface = private, internal