CA2251: String.Equals anstelle von String.Compare verwenden

  • Artikel
Eigenschaft Wert
Regel-ID CA2251
Titel Verwenden von String.Equals über String.Compare
Kategorie Verwendung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Das Ergebnis eines Aufrufs von String.Compare wird mit 0 (null) verglichen.

Regelbeschreibung

String.Compare wurde entwickelt, um einen Vergleich der Gesamtreihenfolge zu erzeugen, der für die Sortierung verwendet werden kann. Wenn Sie nur darauf achten, ob die Zeichenfolgen gleich sind, ist es einfacher und wahrscheinlich schneller, eine entsprechende Überladung von String.Equals zu verwenden.

Behandeln von Verstößen

Ersetzen Sie den Ausdruck, der das Ergebnis von String.Compare mit dem Aufruf von String.Equals vergleicht, um Verstöße gegen diese Regel zu beheben.

Wann sollten Warnungen unterdrückt werden?

Warnungen aus dieser Regel können sicher unterdrückt werden.

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

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

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

Siehe auch