CA1707: Tanımlayıcılar alt çizgi içermemelidir
| Özellik | Değer |
|---|---|
| Kural Kimliği | CA1707 |
| Başlık | Tanımlayıcılar alt çizgi içermemelidir |
| Kategori | Adlandırma |
| Hataya neden olan veya bozulmayan düzeltme | Kesme - derlemelerde yükseltildiğinde Hataya neden olmayan - tür parametrelerinde yükseltildiğinde |
| .NET 9'da varsayılan olarak etkin | Hayır |
Neden
Tanımlayıcının adı alt çizgi (_) karakterini içerir.
Kural açıklaması
Kural gereği, tanımlayıcı adlar alt çizgi (_) karakterini içermez. Kural ad alanlarını, türleri, üyeleri ve parametreleri denetler.
Adlandırma kuralları, ortak dil çalışma zamanını hedefleyen kitaplıklar için ortak bir görünüm sağlar. Bu, yeni yazılım kitaplıkları için gereken öğrenme eğrisini azaltır ve kitaplığın yönetilen kod geliştirme konusunda uzmanlığı olan biri tarafından geliştirildiğine dair müşteri güvenini artırır.
İhlalleri düzeltme
Addan tüm alt çizgi karakterlerini kaldırın.
Uyarıların ne zaman bastırılması gerekiyor?
Üretim kodu için uyarıları gizlemeyin. Ancak test kodu için bu uyarıyı göstermemek 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 CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707
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.CA1707.severity = none
Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.
Microsoft kodunda şu anda alt çizgi kullanan ve değiştirilemeyen iyi bilinen yöntemler için kural gizlenmelidir.
Çö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 (Adlandırma) 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
