CA1058: Typen mogen bepaalde basistypen niet uitbreiden

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-generieke verzamelingen niet uit in je code, tenzij je deze eerder hebt geleverd.

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>
{
}

Hoe schendingen op te lossen

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

Onderdruk geen waarschuwingen van deze regel voor overtredingen met betrekking tot ApplicationException. Het is veilig een waarschuwing van deze regel te onderdrukken voor schendingen met betrekking tot 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 voor meer informatie Hoe codeanalysewaarschuwingen te onderdrukken.

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 configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd, op basis van hun toegankelijkheid, door de optie api_surface in te stellen. 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