CA1030: Uygun yerlerde olaylar kullanın

Makale
11/14/2023

Özellik	Değer
Kural Kimliği	CA1030
Başlık	Uygun yerlerde olayları kullanın
Kategori	Tasarım
Hataya neden olan veya bozulmayan düzeltme	Hataya neden olmayan
.NET 9'da varsayılan olarak etkin	Hayır

Neden

Yöntem adı aşağıdakilerden biriyle başlar:

AddOn
RemoveOn
Ateş
Yükseltmek

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

Kural açıklaması

Bu kural, normalde olaylar için kullanılan adlara sahip yöntemleri algılar. Olaylar Gözlemci veya Yayımla-Abone Ol tasarım desenini izler; bir nesnedeki durum değişikliğinin diğer nesnelere iletilmesi gerektiğinde kullanılırlar. Açıkça tanımlanmış bir durum değişikliğine yanıt olarak bir yöntem çağrılırsa, yöntem bir olay işleyicisi tarafından çağrılmalıdır. Yöntemi direkt olarak çağırmak yerine olayları yükselterek çağıran nesneler.

Olayların bazı yaygın örnekleri, bir düğmeye tıklamak gibi bir kullanıcı eyleminin bir kod kesiminin yürütülmesine neden olduğu kullanıcı arabirimi uygulamalarında bulunur. .NET olay modeli kullanıcı arabirimleriyle sınırlı değildir. Durum değişikliklerini bir veya daha fazla nesneye iletmeniz gereken her yerde kullanılmalıdır.

İhlalleri düzeltme

Bir nesnenin durumu değiştiğinde yöntemi çağrılırsa, tasarımı .NET olay modelini kullanacak şekilde değiştirmeyi göz önünde bulundurun.

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

Yöntem .NET olay modeliyle çalışmazsa, bu kuraldan bir uyarıyı gizleyin.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1030.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.

Belirli API yüzeylerini ekleme

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

Aracılığıyla paylaş