CA1513: Gunakan objectDisposedException throw helper

Properti Nilai
ID Aturan CA1513
Judul Menggunakan pembantu lempar ObjectDisposedException
Kategori Kemampu
Perbaikan bersifat merusak atau tidak merusak Tidak Melanggar
Diaktifkan secara default di .NET 10 Sebagai saran
Bahasa yang berlaku C# dan Visual Basic

Penyebab

Kode memeriksa apakah objek telah dibuang dan kemudian secara kondisional melempar suatu ObjectDisposedException.

Deskripsi aturan

Pemeriksaan objek memiliki dampak besar pada ukuran kode dan sering mendominasi kode untuk fungsi kecil dan setter properti. Pemeriksaan ini mencegah inlining dan menyebabkan polusi cache instruksi yang substansial. Metode throw-helper seperti ThrowIf lebih mudah dan lebih efisien daripada blok if untuk membangun instans pengecualian baru.

Contoh

Cuplikan kode berikut menunjukkan pelanggaran CA1513:

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

Cuplikan kode berikut menunjukkan perbaikan:

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

Cara memperbaiki pelanggaran

Ganti blok if yang melempar pengecualian dengan panggilan ke ThrowIf. Atau, di Visual Studio, gunakan menu bola lampu untuk memperbaiki kode Anda secara otomatis.

Kapan harus menekan peringatan

Aman untuk menyembunyikan pelanggaran aturan ini jika Anda tidak khawatir tentang pemeliharaan kode Anda. Tidak masalah juga untuk menekan pelanggaran yang diidentifikasi sebagai positif palsu.

Menyembunyikan peringatan

Jika Anda hanya ingin menyembunyikan satu pelanggaran, tambahkan arahan praprosedur ke file sumber Anda untuk dinonaktifkan lalu aktifkan kembali aturannya.

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

Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.