CA1512: ArgumentOutOfRangeException throw yardımcısı kullanma
Özellik | Değer |
---|---|
Kural Kimliği | CA1512 |
Başlık | ArgumentOutOfRangeException throw yardımcısı kullanma |
Kategori | Bakýmýný |
Hataya neden olan veya bozulmayan düzeltme | HataYa Neden Olmayan |
.NET 8'de varsayılan olarak etkin | Öneri olarak |
Neden
Kod, bağımsız değişkenin belirli bir değerden küçük mü yoksa daha büyük mü olduğunu denetler ve koşullu olarak bir ArgumentOutOfRangeExceptionoluşturur.
Kural açıklaması
Bağımsız değişken denetimleri, kod boyutu üzerinde önemli bir etkiye sahiptir ve genellikle küçük işlevler ve özellik ayarlayıcıları için koda hakimdir. Bu denetimler, inlining'i engeller ve önemli miktarda yönerge önbelleği kirliliğine neden olur. gibi ArgumentOutOfRangeException.ThrowIfGreaterThan throw-helper yöntemleri, yeni bir özel durum örneği oluşturan bloklardan daha if
basit ve daha verimlidir.
Örnek
Aşağıdaki kod parçacığı CA1512 ihlallerini gösterir:
void M(int arg)
{
if (arg is 0)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg < 0)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg <= 0)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg <= 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg < 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg > 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg >= 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg == 42)
throw new ArgumentOutOfRangeException(nameof(arg));
if (arg != 42)
throw new ArgumentOutOfRangeException(nameof(arg));
}
Aşağıdaki kod parçacığı düzeltmeleri gösterir:
void M(int arg)
{
ArgumentOutOfRangeException.ThrowIfZero(arg);
ArgumentOutOfRangeException.ThrowIfNegative(arg);
ArgumentOutOfRangeException.ThrowIfNegativeOrZero(arg);
ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(arg, 42);
ArgumentOutOfRangeException.ThrowIfLessThan(arg, 42);
ArgumentOutOfRangeException.ThrowIfGreaterThan(arg, 42);
ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual(arg, 42);
ArgumentOutOfRangeException.ThrowIfEqual(arg, 42);
ArgumentOutOfRangeException.ThrowIfNotEqual(arg, 42);
}
İhlalleri düzeltme
if
Özel durum oluşturan bloğu aşağıdaki throw-helper yöntemlerinden birine yapılan bir çağrıyla değiştirin:
- ArgumentOutOfRangeException.ThrowIfZero<T>(T, String)
- ArgumentOutOfRangeException.ThrowIfNegative<T>(T, String)
- ArgumentOutOfRangeException.ThrowIfNegativeOrZero<T>(T, String)
- ArgumentOutOfRangeException.ThrowIfLessThanOrEqual<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfLessThan<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfGreaterThan<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfEqual<T>(T, T, String)
- ArgumentOutOfRangeException.ThrowIfNotEqual<T>(T, T, String)
İsterseniz Visual Studio'da kodunuzu otomatik olarak düzeltmek için ampul menüsünü de kullanabilirsiniz.
Uyarıların ne zaman bastırılması gerekiyor?
Kodunuzun sürdürülebilirliği konusunda endişeleriniz yoksa bu kuralın ihlalini gizlemeniz güvenlidir. Hatalı pozitif olduğu belirlenen ihlallerin gizlenilmesi de uygundur.
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 CA1512
// The code that's violating the rule is on this line.
#pragma warning restore CA1512
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.CA1512.severity = none
Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.