CA1822:将成员标记为 static

  • 项目
属性 值
规则 ID CA1822
标题 将成员标记为 static
类别 “性能”
修复是中断修复还是非中断修复 非中断性 - 无论进行了何种更改，如果成员在程序集外部不可见，则为非中断修复。

非中断 - 如果只使用 this 关键字将成员更改为实例成员，则为非中断修复。

非中断 - 如果将成员从实例成员更改为静态成员，并且该成员在程序集外部可见，则为中断修复。
在 .NET 8 中默认启用 作为建议

原因

不访问实例数据的成员未标记为静态（在 Visual Basic 中为共享）。

规则说明

可以将不访问实例数据或不调用实例方法的成员标记为静态（在 Visual Basic 中为共享）。 在将这些方法标记为 static 之后，编译器将向这些成员发出非虚拟调用站点。 发出非虚拟调用网站将禁止在运行时检查每个调用，以确保当前对象指针为非 NULL。 这会使性能敏感的代码的性能得到显著提高。 在某些情况下，访问当前对象实例失败表示存在正确性问题。

如何解决冲突

将成员标记为静态（在 Visual Basic 中为共享），或在方法主体中使用“this”/“Me”（如果适用）。

何时禁止显示警告

对于以前发布的代码，可禁止显示此规则的警告，因为修复是一项中断性变更。

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

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

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

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

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

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

可以仅为此规则、为适用的所有规则或为适用的此类别（性能）中的所有规则配置此选项。 有关详细信息，请参阅代码质量规则配置选项。

包含特定的 API 图面

你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.api_surface = private, internal