CA2208: Bağımsız değişken özel durumlarını doğru örnekleyin

Özellik	Değer
Kural Kimliği	CA2208
Başlık	Bağımsız değişken özel durumlarını doğru örnekleyin
Kategori	Kullanım
Hataya neden olan veya bozulmayan düzeltme	Hataya neden olmayan
.NET 10'da varsayılan olarak etkin	Öneri olarak

Neden

Bir yöntemin parametresi olduğunda ve bir özel durum türü (veya türünden türetildiğinde) ArgumentExceptionparametresini doğru kabul eden bir paramName oluşturucuyu çağırması beklenir. Olası nedenler şunlardır:

• Bir parametreyi kabul eden bir oluşturucuya sahip olan veya türetilen ArgumentException bir özel durum türünün varsayılan (parametresiz) oluşturucusunun paramName çağrısı yapılır.
• Hatalı dize bağımsız değişkeni, bir özel durum türünün parametreli oluşturucusundan türetilen veya türünden türetilen ArgumentExceptionbir parametreli oluşturucuya geçirilir. Örneğin, paramName bağımsız değişken yöntemin parametrelerinden birinin adıyla eşleşmiyor.
• Bir özel durum türünün oluşturucusunun bağımsız değişkeni için message bir parametre adı geçirilir. Bu ad, türünden türetilir ArgumentException.

Kural açıklaması

Varsayılan oluşturucuyu çağırmak yerine, daha anlamlı bir özel durum iletisinin sağlanmasına izin veren oluşturucu aşırı yüklemelerinden birini çağırın. Özel durum iletisi geliştiriciyi hedeflemeli ve hata koşulunu ve özel durumu düzeltmeyi veya önlemeyi açıkça açıklamalıdır.

ve türetilmiş türlerinin bir ve iki dize oluşturucusunun ArgumentException imzaları konum message ve paramName parametrelerle tutarlı değildir. Bu oluşturucuların doğru dize bağımsız değişkenleriyle çağrıldıklarından emin olun. İmzalar aşağıdaki gibidir:

• ArgumentException(string message)
• ArgumentException(string message, string paramName)
• ArgumentNullException(string paramName)
• ArgumentNullException(string paramName, string message)
• ArgumentOutOfRangeException(string paramName)
• ArgumentOutOfRangeException(string paramName, string message)
• DuplicateWaitObjectException(string parameterName)
• DuplicateWaitObjectException(string parameterName, string message)

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için, bir ileti, parametre adı veya her ikisini birden alan bir oluşturucu çağırın ve bağımsız değişkenlerin çağrılan tür ArgumentException için uygun olduğundan emin olun.

İpucu

Yanlış konumlandırılmış parametre adları için Visual Studio'da bir kod düzeltmesi kullanılabilir. Bunu kullanmak için imleci uyarı satırına getirin ve Ctrl Sunulan seçenekler listesinden Bağımsız değişken sırasını değiştir'i seçin.

yönteme ArgumentException(String) ileti yerine parametre adı geçirilirse, düzeltici bunun yerine iki bağımsız değişken oluşturucuya geçme seçeneği sağlar.

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

Yalnızca doğru dize bağımsız değişkenleriyle parametreli bir oluşturucu çağrıldığında 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 CA2208
// The code that's violating the rule is on this line.
#pragma warning restore CA2208

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.CA2208.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

api_surface seçeneğini ayarlayarak, bu kuralın erişilebilirliği temelinde kod tabanınızın hangi bölümlerinde çalıştırılacaklarını 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

Not

XXXX CAXXXX bölümünü geçerli kuralın kimliğiyle değiştirin.

Varsayılan olarak, CA2208 kuralı tüm API yüzeyleri (genel, iç ve özel) için geçerlidir.

Örnek

Aşağıdaki kod, örneğini ArgumentNullExceptionhatalı bir şekilde başlatan bir oluşturucuyu gösterir.

public class Book
{
    public Book(string title)
    {
        Title = title ??
            throw new ArgumentNullException("All books must have a title.", nameof(title));
    }

    public string Title { get; }
}

Public Class Book

    Private ReadOnly _Title As String

    Public Sub New(ByVal title As String)
        ' Violates this rule (constructor arguments are switched)            
        If (title Is Nothing) Then
            Throw New ArgumentNullException("title cannot be a null reference (Nothing in Visual Basic)", "title")
        End If
        _Title = title
    End Sub

    Public ReadOnly Property Title()
        Get
            Return _Title
        End Get
    End Property

End Class

Aşağıdaki kod, oluşturucu bağımsız değişkenlerini değiştirerek önceki ihlali düzeltir.

public class Book
{
    public Book(string title)
    {
        Title = title ??
            throw new ArgumentNullException(nameof(title), "All books must have a title.");
    }

    public string Title { get; }
}

Public Class Book

    Private ReadOnly _Title As String

    Public Sub New(ByVal title As String)
        If (title Is Nothing) Then
            Throw New ArgumentNullException("title", "title cannot be a null reference (Nothing in Visual Basic)")
        End If

        _Title = title
    End Sub

    Public ReadOnly Property Title()
        Get
            Return _Title
        End Get
    End Property

End Class

Aşağıdaki kod, yöntemin parametrelerinden hiçbirine uymayan ArgumentNullException ile hatalı bir şekilde paramName atan bir yöntem göstergesi sunar. Kural, yöntem parametresi değil yerel bir değişken olduğundan description tetikler.

public class Product
{
    public string? Description { get; set; }
    public string Name { get; set; } = string.Empty;
}

public class Example
{
    // Violates CA2208: 'description' is not a parameter of this method.
    public void ProcessProduct(Product product)
    {
        string? description = product.Description;
        if (description is null)
        {
            throw new ArgumentNullException(nameof(description), $"Product named {product.Name} had no description!");
        }
        // Process description...
    }
}

Public Class Product
    Public Property Description As String
    Public Property Name As String = String.Empty
End Class

Public Class Example
    ' Violates CA2208: 'description' is not a parameter of this method.
    Public Sub ProcessProduct(ByVal product As Product)
        Dim description As String = product.Description
        If description Is Nothing Then
            Throw New ArgumentNullException(NameOf(description), $"Product named {product.Name} had no description!")
        End If
        ' Process description...
    End Sub
End Class

Aşağıdaki kod, nesnenin durumu geçersiz olduğunda uygun olan önceki ihlali bunun yerine kullanarak InvalidOperationException düzeltir.

public class Product
{
    public string? Description { get; set; }
    public string Name { get; set; } = string.Empty;
}

public class Example
{
    // Fixed: Use InvalidOperationException for invalid object state.
    public void ProcessProduct(Product product)
    {
        string? description = product.Description;
        if (description is null)
        {
            throw new InvalidOperationException($"Product named {product.Name} had no description!");
        }
        // Process description...
    }
}

Public Class Product
    Public Property Description As String
    Public Property Name As String = String.Empty
End Class

Public Class Example
    ' Fixed: Use InvalidOperationException for invalid object state.
    Public Sub ProcessProduct(ByVal product As Product)
        Dim description As String = product.Description
        If description Is Nothing Then
            Throw New InvalidOperationException($"Product named {product.Name} had no description!")
        End If
        ' Process description...
    End Sub
End Class

İlgili kurallar

• CA1507: Dize yerine nameof kullanın