CA2208: Utwórz poprawne wystąpienia wyjątków argumentów

Właściwości	Wartość
Identyfikator reguły	CA2208
Tytuł	Poprawnie twórz wystąpienia wyjątków argumentów
Kategoria	Użycie
Poprawka powodująca niezgodność lub niezgodność	Niezgodność
Domyślnie włączone na platformie .NET 9	Jako sugestia

Przyczyna

Jeśli metoda ma parametr i zgłasza typ wyjątku, który jest lub pochodzi z , oczekuje się, ArgumentExceptionże konstruktor przyjmuje paramName poprawnie parametr. Możliwe przyczyny obejmują następujące sytuacje:

• Wywołanie jest wykonywane do domyślnego (bez parametrów) konstruktora typu wyjątku, który jest lub pochodzi od, który ma również konstruktor, ArgumentException który akceptuje paramName parametr.
• Nieprawidłowy argument ciągu jest przekazywany do sparametryzowanego konstruktora typu wyjątku, który jest lub pochodzi z ArgumentExceptionklasy .
• Jedna z nazw parametrów jest przekazywana dla message argumentu konstruktora typu wyjątku, który jest lub pochodzi od , ArgumentException.

Opis reguły

Zamiast wywoływać konstruktor domyślny, wywołaj jedno z przeciążeń konstruktora, które pozwala na zapewnienie bardziej znaczącego komunikatu o wyjątku. Komunikat o wyjątku powinien być skierowany do dewelopera i jasno wyjaśnić warunek błędu oraz jak poprawić lub uniknąć wyjątku.

Podpisy jednego i dwóch konstruktorów ciągów ArgumentException i jego typów pochodnych nie są zgodne z położeniem message i paramName parametrami. Upewnij się, że te konstruktory są wywoływane z poprawnymi argumentami ciągu. Podpisy są następujące:

• 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)

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, wywołaj konstruktor, który przyjmuje komunikat, nazwę parametru lub oba te elementy i upewnij się, że argumenty są odpowiednie dla typu wywoływanego ArgumentException .

Napiwek

Poprawka kodu jest dostępna w programie Visual Studio dla niepoprawnie umieszczonych nazw parametrów. Aby go użyć, umieść kursor w wierszu ostrzeżenia i naciśnij Ctrl+. (kropka). Wybierz pozycję Zamień kolejność argumentów z wyświetlonej listy opcji.

Jeśli nazwa parametru zamiast komunikatu jest przekazywana do ArgumentException(String) metody, poprawka udostępnia opcję przełączenia do konstruktora dwóch argumentów.

Kiedy pomijać ostrzeżenia

Można bezpiecznie pominąć ostrzeżenie z tej reguły tylko wtedy, gdy konstruktor sparametryzowany jest wywoływany z poprawnymi argumentami ciągu.

Pomijanie ostrzeżenia

Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

#pragma warning disable CA2208
// The code that's violating the rule is on this line.
#pragma warning restore CA2208

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

[*.{cs,vb}]
dotnet_diagnostic.CA2208.severity = none

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części bazy kodu mają być uruchamiane w tej regule.

• Uwzględnij określone powierzchnie interfejsu API

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (Projekt), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Uwzględnij określone powierzchnie interfejsu API

Możesz skonfigurować, na których częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Domyślnie reguła CA2208 dotyczy wszystkich powierzchni interfejsu API (publicznych, wewnętrznych i prywatnych).

Przykład

Poniższy kod przedstawia konstruktor, który niepoprawnie tworzy wystąpienie klasy ArgumentNullException.

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

Poniższy kod naprawia poprzednie naruszenie, przełączając argumenty konstruktora.

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

Powiązane reguły

• CA1507: Użyj nazwy zamiast ciągu