CA1310: "StringComparison" für Richtigkeit angeben

  • Artikel
Eigenschaft Wert
Regel-ID CA1310
Titel "StringComparison" für Richtigkeit angeben
Kategorie Globalisierung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein Zeichenfolgenvergleichsvorgang verwendet eine Methodenüberladung, die keinen StringComparison-Parameter festgelegt und standardmäßig einen kulturspezifischen Zeichenfolgenvergleich verwendet. Daher unterscheidet sich das Verhalten je nach den Gebietsschema-Einstellungen des aktuellen Benutzers.

Regelbeschreibung

Eine Zeichenfolgenvergleichsmethode, die standardmäßig einen kulturspezifischen Zeichenfolgenvergleich verwendet, kann potenziell unbeabsichtigtes Laufzeitverhalten aufweisen, das nicht der Absicht des Benutzers entspricht. Es wird empfohlen, die Überladung mit dem StringComparison-Parameter zu verwenden, um Richtigkeit und Klarheit der Absicht zu garantieren.

Diese Regel markiert Zeichenfolgenvergleichsmethoden, die standardmäßig den kulturabhängigen StringComparison-Wert verwenden. Weitere Informationen finden Sie unter Zeichenfolgenvergleiche mit der aktuellen Kultur.

Hinweis

Wenn Sie Verletzungen für alle Zeichenfolgenvergleichsmethoden anzeigen möchten, unabhängig vom standardmäßigen Zeichenfolgenvergleich, der von der Methode verwendet wird, verwenden Sie stattdessen CA1307: StringComparison aus Gründen der Übersichtlichkeit angeben.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, ändern Sie die Zeichenfolgenvergleichsmethoden zu Überladungen, die StringComparison-Enumeration als Parameter akzeptieren. Sie können z. B. String.Compare(str1, str2) in String.Compare(str1, str2, StringComparison.Ordinal) ändern.

Wann sollten Warnungen unterdrückt werden?

Es ist sicher, eine Warnung aus dieser Regel zu unterdrücken, wenn die Bibliothek oder die Anwendung nicht lokalisiert werden soll.

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 CA1310
// The code that's violating the rule is on this line.
#pragma warning restore CA1310

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.CA1310.severity = none

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

Weitere Informationen