CA1070: Olay alanlarını sanal olarak bildirmeyin

  • Makale
Özellik Değer
Kural Kimliği CA1070
Başlık Olay alanlarını sanal olarak bildirme
Kategori Tasarım
Hataya neden olan veya bozulmayan düzeltme Yeni
.NET 8'de varsayılan olarak etkin Öneri olarak

Neden

Alan benzeri bir olay sanal olarak bildirildi.

Varsayılan olarak, bu kural yalnızca dışarıdan görünen türlere bakar, ancak bu yapılandırılabilir.

Kural açıklaması

Türetilmiş sınıflarda temel sınıf olaylarını yükseltmek için bu .NET tasarım yönergelerini izleyin. Bir temel sınıfta sanal olayları bildirmeyin. Türetilmiş bir sınıfta geçersiz kılınan olayların tanımsız davranışı vardır. C# derleyicisi bunu doğru şekilde işlemez ve türetilmiş olaya abonenin temel sınıf olayına abone olup olmayacağı tahmin edilemez.

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

İhlalleri düzeltme

Bu .NET tasarım yönergelerini izleyin ve sanal alan benzeri olaylardan kaçının.

Uyarıların ne zaman bastırılması gerekiyor?

Olay, zaten gönderilen kitaplığın parçası olan dışarıdan görünür bir genel API ise, kitaplık tüketicileri için hataya neden olan bir değişikliği önlemek için bu kuraldan gelen bir uyarıyı engellemek güvenlidir.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Çözümlemek için kod yapılandırma

Bu kuralın kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırmak için aşağıdaki seçeneği kullanın.

Bu seçeneği yalnızca bu kural, geçerli olduğu tüm kurallar veya bu kategorideki (Tasarım) tüm kurallar için yapılandırabilirsiniz. Daha fazla bilgi için bkz . Kod kalitesi kuralı yapılandırma seçenekleri.

Belirli API yüzeylerini ekleme

Bu kuralın üzerinde çalıştırılacak kod tabanınızın hangi bölümlerini erişilebilirliklerine göre yapılandırabilirsiniz. Örneğin, kuralın yalnızca genel olmayan API yüzeyinde çalıştırılması gerektiğini belirtmek için projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Ayrıca bkz.