CA1507: Verwenden von nameof anstelle der Zeichenfolge

  • Artikel
Eigenschaft Wert
Regel-ID CA1507
Titel Verwenden von nameof anstelle der Zeichenfolge
Kategorie Wartbarkeit
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert Als Vorschlag

Ursache

Ein string-Literal oder eine -Konstante, die mit dem Namen eines Parameters der enthaltenden Methode oder dem Namen einer Eigenschaft des enthaltenden Typs übereinstimmt, wird als Argument für eine Methode verwendet.

Regelbeschreibung

Rule CA1507 kennzeichnet die Verwendung eines string Literals als Argument für eine Methode oder einen Konstruktor an, bei der ein nameof (NameOf in Visual Basic) Ausdruck die Wartbarkeit erhöhen würde. Die Regel wird ausgelöst, wenn alle der folgenden Bedingungen erfüllt sind:

  • Das Argument ist string-Literal oder eine -Konstante.

  • Das-Argument entspricht einem string-typisierten Parameter der Methode oder dem Konstruktor, der aufgerufen wird (d. h., es ist keine Konvertierung an der Aufruf-Site beteiligt).

  • Entweder:

    • Der deklarierte Name des Parameters ist paramName und der konstante Wert des string-Literals entspricht dem Namen eines Parameters der Methode, der Lambda-Funktion oder der lokalen Funktion, in der die Methode oder der Konstruktor aufgerufen wird.

    • Der deklarierte Name des Parameters ist propertyName und der konstante Wert des string-Literals entspricht dem Namen eines Parameters der Methode, der Lambda-Funktion oder der lokalen Funktion, in der die Methode oder der Konstruktor aufgerufen wird.

Rule CA1507 verbessert die Code-Wartbarkeit in Fällen, in denen der Parameter in Zukunft umbenannt werden kann, das string-Literal aber versehentlich nicht umbenannt wird. Mithilfe von nameof wird das Symbol umbenannt, wenn der Parameter durch einen Umgestaltungsvorgang umbenannt wird. Außerdem werden alle Rechtschreibfehler im Namen des Parameters vom Compiler abgefangen.

Behandeln von Verstößen

Um einen Verstoß zu beheben, ersetzen Sie das string-Literal durch einen nameof (NameOf in Visual Basic) Ausdruck. Die folgenden beiden Codeausschnitte zeigen z. B. einen Verstoß gegen die Regel und wie dieser korrigiert werden kann:

public Book(string title)
{
    // Violates rule CA1507
    Title = title ?? throw new ArgumentNullException("title", "All books must have a title.");
}

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

Tipp

Für diese Regel ist ein Codefix in Visual Studio verfügbar. Um sie zu verwenden, muss der Cursor auf dem string-Literal platziert und Ctrl+. (Punkt) gedrückt werden. Wählen Sie Verwenden von nameof zum Ausdrücken von Symbolnamen aus der Liste der angezeigten Optionen aus.

Code fix for CA1507 - use nameof to express symbol names

Wann sollten Warnungen unterdrückt werden?

Es ist sicher, einen Verstoß gegen diese Regel zu unterdrücken, wenn Sie sich keine Gedanken über die Wartbarkeit Ihres Codes machen.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Siehe auch