CA1513: Az ObjectDisposedException dobási segéd használata

Tulajdonság Érték
Szabályazonosító CA1513
Cím Használd az ObjectDisposedException dobási segédet
Kategória Fenntarthatóság
A javítás romboló vagy nem romboló Nem törhető
Alapértelmezés szerint engedélyezve a .NET 10-ben Javaslatként
Alkalmazandó nyelvek C# és Visual Basic

Ok

A kód ellenőrzi, hogy egy objektum meg van-e semmisítve, majd feltételesen eldob egy ObjectDisposedException.

Szabály leírása

Az objektumellenőrzések jelentős hatással vannak a kód méretére, és gyakran uralják a kódot a kis függvények és a tulajdonsághalmazok esetében. Ezek az ellenőrzések megakadályozzák az inlinelést, és jelentős utasítás-cache szennyezést okoznak. A dobássegítő módszerek, például ThrowIf egyszerűbbek és hatékonyabbak, mint if az új kivételpéldányt építő blokkok.

Példa

A következő kódrészlet a CA1513 megsértését mutatja be:

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

A következő kódrészlet a javítást mutatja:

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

Szabálysértések kijavítása

Cserélje le a if blokkot, amely kivételt okoz, egy ThrowIf hívásával. Vagy a Visual Studióban a villanykörte menü használatával automatikusan kijavíthatja a kódot.

Mikor kell letiltani a figyelmeztetéseket?

Ha nem aggódik a kód karbantarthatósága miatt, nyugodtan letilthatja a szabály megsértését. Rendben van az is, ha figyelmen kívül hagyja a hamis pozitívnak minősített szabálysértéseket.

Figyelmeztetés mellőzése

Ha csak egyetlen szabálysértést szeretne letiltani, adjon hozzá előfeldolgozási irányelveket a forrásfájlhoz a szabály letiltásához és újbóli engedélyezéséhez.

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

Ha le szeretné tiltani egy fájl, mappa vagy projekt szabályát, állítsa annak súlyosságát none a konfigurációs fájlban.

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

További információ: Kódelemzési figyelmeztetések letiltása.