CA1014: Derlemeleri CLSCompliantAttribute ile işaretleme

Makale
09/06/2023

Özellik	Değer
Kural Kimliği	CA1014
Başlık	Derlemeleri CLSCompliantAttribute ile işaretle
Kategori	Tasarım
Hataya neden olan veya bozulmayan düzeltme	Hataya neden olmayan
.NET 9'da varsayılan olarak etkin	Hayır

Neden

Derlemede System.CLSCompliantAttribute özniteliği uygulanmaz.

Kural açıklaması

Ortak Dil Tanımlaması (CLS) ad kısıtlamalarını, veri türlerini ve karşıt programlama dillerini kullanırsa derlemelerin uyması zorunlu olan kuralları tanımlar. İyi tasarım, tüm derlemelerin ile CLSCompliantAttributeCLS uyumluluğunu açıkça belirttiğini belirtir. Öznitelik bir derlemede yoksa, derleme uyumlu değildir.

CLS uyumlu bir derlemenin uyumlu olmayan türler veya tür üyeleri içermesi mümkündür.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için özniteliğini derlemeye ekleyin. Derlemenin tamamını uyumsuz olarak işaretlemek yerine, hangi tür veya tür üyelerinin uyumlu olmadığını belirlemeniz ve bu öğeleri bu şekilde işaretlemeniz gerekir. Mümkünse, mümkün olan en geniş hedef kitlenin derlemenizin tüm işlevlerine erişebilmesi için uyumsuz üyeler için CLS uyumlu bir alternatif sağlamanız gerekir.

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

Bu kuraldan uyarıyı bastırmayın. Derlemenin uyumlu olmasını istemiyorsanız özniteliğini uygulayın ve değerini olarak falseayarlayın.

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

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.CA1014.severity = none

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

Örnek

Aşağıdaki örnekte, CLS uyumlu olduğunu bildiren özniteliği uygulanmış bir derleme System.CLSCompliantAttribute gösterilmektedir.

[assembly:CLSCompliant(true)]
namespace DesignLibrary {}

<assembly:CLSCompliant(true)>
Namespace DesignLibrary
End Namespace

Aracılığıyla paylaş