CA1513: ObjectDisposedException throw helper gebruiken

Eigenschap	Waarde
Regel-id	CA1513
Titel	Gebruik de 'ObjectDisposedException throw helper'
Categorie	Onderhoudbaarheid
Fix kan brekend of niet-brekend zijn	Onbreekbaar
Standaard ingeschakeld in .NET 10	Als suggestie
Toepasselijke talen	C# en Visual Basic

Oorzaak

Code controleert of een object wordt verwijderd en genereert vervolgens voorwaardelijk een ObjectDisposedException.

Beschrijving van regel

Objectcontroles hebben een aanzienlijke invloed op de codegrootte en overheersen vaak de code voor kleine functies en eigenschappensetters. Deze controles verhinderen inlining en veroorzaken aanzienlijke vervuiling van de instructiecache. Throw-helper-methoden, zoals ThrowIf, zijn eenvoudiger en efficiënter dan if-blokken die een nieuwe uitzonderingsinstantie maken.

Voorbeeld

In het volgende codefragment ziet u een schending van CA1513:

class C
{
    private bool _disposed = false;
    void M()
    {
        if (_disposed)
            throw new ObjectDisposedException(GetType().Name);
    }
}

In het volgende codefragment ziet u de oplossing:

class C
{
    private bool _disposed = false;
    void M()
    {
        ObjectDisposedException.ThrowIf(_disposed, this);
    }
}

Hoe schendingen op te lossen

Vervang het if blok dat de uitzondering genereert door een aanroep naar ThrowIf. Of gebruik in Visual Studio het gloeilampmenu om uw code automatisch te herstellen.

Wanneer waarschuwingen onderdrukken

Het is veilig om een schending van deze regel te onderdrukken als u zich geen zorgen maakt over de onderhoudbaarheid van uw code. Het is ook prima om schendingen te onderdrukken die worden geïdentificeerd als vals-positieven.

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

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.CA1513.severity = none

Zie voor meer informatie Hoe codeanalysewaarschuwingen te onderdrukken.