CA1052:静态容器类型应是 Static 或NotInheritable
属性 | 值 |
---|---|
规则 ID | CA1052 |
标题 | 静态容器类型应为 Static 或 NotInheritable |
类别 | 设计 |
修复是中断修复还是非中断修复 | 重大 |
在 .NET 8 中默认启用 | 否 |
原因
非抽象类型只包含静态成员(可能的默认构造函数除外),而且没有使用 static 或 Shared 修饰符进行声明。
默认情况下,此规则仅查看外部可见的类型,但这是可配置的。
规则说明
规则 CA1052 假定仅包含不设计为继承的静态成员的类型,因为该类型不提供任何可在派生类型中重写的功能。 未计划继承的类型应该用 C# 中的 static
修饰符进行标记,以便禁止其作为基类型使用。 此外,应删除其默认构造函数。 在 Visual Basic 中,类应转换为模块。
对于抽象类或具有基类的类,不会触发此规则。 但是,对于支持空接口的类,则会触发此规则。
注意
在该规则的最新分析器实现中,还包含规则 CA1053 的功能。
如何解决冲突
若要解决此规则的冲突,请将类型标记为 static
,并删除默认构造函数 (C#),或将其转换为模块 (Visual Basic)。
何时禁止显示警告
在以下情况下,可以禁止显示冲突:
- 类型设计为继承。 缺少
static
修饰符,表明该类型可用作基类型。 - 此类型不能用作类型参数。 静态类型不能用作类型参数。
抑制警告
如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。
#pragma warning disable CA1052
// The code that's violating the rule is on this line.
#pragma warning restore CA1052
若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none
。
[*.{cs,vb}]
dotnet_diagnostic.CA1052.severity = none
有关详细信息,请参阅如何禁止显示代码分析警告。
配置代码以进行分析
使用下面的选项来配置代码库的哪些部分要运行此规则。
可以仅为此规则、为适用的所有规则或为适用的此类别(设计)中的所有规则配置此选项。 有关详细信息,请参阅代码质量规则配置选项。
包含特定的 API 图面
你可以根据代码库的可访问性,配置要针对其运行此规则的部分。 例如,若要指定规则应仅针对非公共 API 图面运行,请将以下键值对添加到项目中的 .editorconfig 文件:
dotnet_code_quality.CAXXXX.api_surface = private, internal
冲突示例
以下示例显示与此规则冲突的类型:
public class StaticMembers
{
public static int SomeProperty { get; set; }
public static void SomeMethod() { }
}
Imports System
Namespace ca1052
Public Class StaticMembers
Shared Property SomeProperty As Integer
Private Sub New()
End Sub
Shared Sub SomeMethod()
End Sub
End Class
End Namespace
使用静态修改器来解决
以下示例演示如何在 C# 中使用 static
修饰符来标记类型,以解决此规则的冲突:
public static class StaticMembers
{
public static int SomeProperty { get; set; }
public static void SomeMethod() { }
}