Bagikan melalui

CA1070: Jangan deklarasikan bidang peristiwa sebagai virtual

  • Artikel
Properti Nilai
ID Aturan CA1070
Judul Jangan mendeklarasikan bidang peristiwa sebagai virtual
Golongan Desain
Perbaikan bersifat disruptif atau non-disruptif Merusak
Diaktifkan secara default di .NET 8 Sebagai saran

Penyebab

Peristiwa seperti bidang dideklarasikan sebagai virtual.

Secara default, aturan ini hanya melihat jenis yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Ikuti panduan desain .NET ini untuk menaikkan peristiwa kelas dasar di kelas turunan. Jangan mendeklarasikan peristiwa virtual di kelas dasar. Peristiwa yang ditimpa dalam kelas turunan memiliki perilaku yang tidak ditentukan. Pengkompilasi C# tidak menangani ini dengan benar dan tidak dapat diprediksi apakah pelanggan untuk peristiwa turunan sebenarnya akan berlangganan peristiwa kelas dasar.

using System;
public class C
{
    // CA1070: Event 'ThresholdReached' should not be declared virtual.
    public virtual event EventHandler ThresholdReached;
}

Cara memperbaiki pelanggaran

Ikuti panduan desain .NET ini dan hindari peristiwa seperti bidang virtual.

Kapan harus menekan peringatan

Jika peristiwa tersebut adalah API publik yang terlihat secara eksternal yang sudah menjadi bagian dari pustaka yang dikirim, maka aman untuk menekan peringatan dari aturan ini untuk menghindari perubahan yang melanggar bagi konsumen pustaka.

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

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Mengonfigurasi kode yang akan dianalisis

Gunakan opsi berikut untuk mengonfigurasi bagian mana dari codebase Anda yang akan menjalankan aturan ini.

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku untuknya, atau untuk semua aturan dalam kategori ini (Desain) yang berlaku untuk aturan ini. Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian mana dari basis kode yang akan menjalankan aturan ini, berdasarkan aksesibilitasnya. Misalnya, untuk menentukan bahwa aturan hanya boleh dijalankan pada permukaan API non-publik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Baca juga