CA1830:在 StringBuilder 上优先使用强类型“追加和插入”方法重载

项目
12/18/2023

属性	值
规则 ID	CA1830
标题	在 StringBuilder 上优先使用强类型“追加和插入”方法重载
类别	“性能”
修复是中断修复还是非中断修复	非中断
在 .NET 8 中默认启用	作为建议

原因

调用 StringBuilder Append 或 Insert 方法时，使用的是对 Append 或 Insert 方法有专用重载的类型调用 ToString 生成的参数。

规则说明

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

有关详细信息，请参阅如何禁止显示代码分析警告。

另请参阅

性能规则

通过