CA1830: Bevorzugen Sie stark typisierte Append- und Insert-Methodenüberladungen für StringBuilder.

  • Artikel
Eigenschaft Wert
Regel-ID CA1830
Titel Bevorzugen Sie stark typisierte Append- und Insert-Methodenüberladungen für StringBuilder.
Kategorie Leistung
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert Als Vorschlag

Ursache

Eine StringBuilderAppend- oder Insert-Methode wurde mit einem Argument aufgerufen, das Ergebnis des Aufrufs von ToString für einen Typ war, für den die Append- oder Insert-Methode über eine dedizierte Überladung verfügt.

Regelbeschreibung

Append und Insert stellen Überladungen für mehrere Typen über String hinaus bereit. Bevorzugen Sie nach Möglichkeit die stark typisierten Überladungen anstatt der Verwendung von ToString() und der auf Zeichenfolgen basierten Überladung.

Behandeln von Verstößen

Löschen Sie das unnötige ToString() aus dem Aufruf.

using System.Text;

class C
{
    int _value;

    // Violation
    public void Log(StringBuilder destination)
    {
        destination.Append("Value: ").Append(_value.ToString()).AppendLine();
    }

    // Fixed
    public void Log(StringBuilder destination)
    {
        destination.Append("Value: ").Append(_value).AppendLine();
    }
}

Wann sollten Warnungen unterdrückt werden?

Es ist sicher, einen Verstoß gegen diese Regel zu unterdrücken, wenn Sie sich keine Gedanken über die Auswirkungen auf die Leistung der unnötigen Zeichenfolgenzuteilungen 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 CA1830
// The code that's violating the rule is on this line.
#pragma warning restore CA1830

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

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

Siehe auch