CA1713: Event tidak boleh memiliki prefiks before atau after

Properti Nilai
ID Aturan CA1713
Judul Peristiwa tidak boleh memiliki prefiks sebelum atau sesudah
Kategori Penamaan
Perbaikan bersifat merusak atau tidak merusak Merusak
Diaktifkan secara default di .NET 10 Tidak
Bahasa yang berlaku C# dan Visual Basic

Penyebab

Nama peristiwa dimulai dengan 'Sebelum' atau 'Setelah'.

Deskripsi aturan

Nama peristiwa harus menjelaskan tindakan yang memunculkan peristiwa. Untuk memberi nama peristiwa terkait yang dimunculkan dalam urutan tertentu, gunakan present atau past tense untuk menunjukkan posisi relatif dalam urutan tindakan. Misalnya, saat menamai sepasang peristiwa yang dimunculkan saat menutup sumber daya, Anda mungkin menamainya 'Closing' dan 'Closed', alih-alih 'BeforeClose' dan 'AfterClose'.

Konvensi penamaan menyediakan keseragaman tampilan untuk pustaka yang menargetkan common language runtime. Hal ini mengurangi kurva pembelajaran yang diperlukan untuk pustaka perangkat lunak baru, dan meningkatkan keyakinan pelanggan bahwa pustaka dikembangkan oleh seseorang yang memiliki keahlian dalam mengembangkan kode terkendali.

Cara memperbaiki pelanggaran

Hapus awalan dari nama acara, dan pertimbangkan untuk mengubah nama untuk menggunakan bentuk sekarang atau bentuk lampau dari kata kerja.

Example

public class Session
{
    // This code violates the rule.
    public event EventHandler? BeforeClose;
    public event EventHandler? AfterClose;

    // This code satisfies the rule.
    public event EventHandler? Closing;
    public event EventHandler? Closed;
}

Kapan harus menekan peringatan

Jangan menyembunyikan peringatan dari aturan ini.