CA1830：建議在 StringBuilder 上使用強型別 Append 及 Insert 方法多載

發行項
12/16/2023

屬性	值
規則識別碼	CA1830
標題	建議在 StringBuilder 上使用強型別 Append 及 Insert 方法多載
類別	效能
修正程式是中斷或非中斷	不中斷
預設在 .NET 8 中啟用	建議

原因

呼叫或方法時，引數是呼叫或 InsertInsert 方法具有專用多載之型 Append 別的結果 ToString 。 StringBuilderAppend

檔案描述

Append 和 Insert 會為 String 以外的多個型別提供多載。可能的話，請使用強型別多載，而非使用 ToString () 和以字串為基礎的多載。

如何修正違規

從調用中刪除不必要的 ToString() 。

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();
    }
}

隱藏警告的時機

如果您不擔心不必要的字串配置對效能的影響，則隱藏此規則的違規是安全的。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

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

若要停用檔案、資料夾或專案的規則，請在組態檔中將其嚴重性設定為。 none

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

如需詳細資訊，請參閱如何隱藏程式碼分析警告。

另請參閱

效能規則