CA1834：針對單一字元字串使用 StringBuilder.Append(char)

發行項
11/12/2024

屬性	值
規則識別碼	CA1834
職稱	針對單一字元字串使用 StringBuilder.Append(char)
類別	效能
修正程式是中斷或非中斷	不中斷
預設在 .NET 9 中啟用	建議

原因

當將單位長度字串傳遞至 Append 方法時，就會引發此規則。

檔案描述

使用單位長度字串呼叫 StringBuilder.Append 時，請考慮使用 const char 而不是單位長度 const string 來改善效能。

如何修正違規

違規可以手動修正，或在某些情況下，使用快速動作修正Visual Studio中的程式碼。範例：

範例 1

具有單位長度字串常值的呼叫 StringBuilder.Append ：

using System;
using System.Text;

namespace TestNamespace
{
    class TestClass
    {
        private void TestMethod()
        {
            StringBuilder sb = new StringBuilder();
            sb.Append("a");
        }
    }
}

提示

Visual Studio 中有一個程式代碼修正程式代碼可供此規則使用。若要使用它，請將游標放在違規上，然後按 Ctrl+。（句號）。當適用時，請選擇 [考慮使用 'StringBuilder.Append（char）']。 從顯示的選項清單中。

CA1834 的程式代碼修正 - 針對單一字元字串使用 StringBuilder.Append（char）

Visual Studio 套用的修正：

using System;
using System.Text;

namespace TestNamespace
{
    class TestClass
    {
        private void TestMethod()
        {
            StringBuilder sb = new StringBuilder();
            sb.Append('a');
        }
    }
}

在某些情況下，例如，使用單位長度 const string 類別欄位時，Visual Studio 不會建議程式代碼修正（但分析器仍會引發）。這些實例需要手動修正。

範例 2

具有const string單位長度之類別欄位的呼叫StringBuilder.Append：

using System;
using System.Text;

namespace TestNamespace
{
    public class Program
    {
        public const string unitString = "a";

        static void Main(string[] args)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append(unitString);
        }
    }
}

仔細分析之後， unitString 您可以在這裡變更為 char ，而不會造成任何建置錯誤。

using System;
using System.Text;

namespace TestNamespace
{
    public class Program
    {
        public const char unitString = 'a';

        static void Main(string[] args)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append(unitString);
        }
    }
}

隱藏警告的時機

如果您不擔心在使用 StringBuilder時改善效能，則隱藏此規則的違規是安全的。

隱藏警告

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

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

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

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

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

另請參閱

效能規則

共用方式為