通过

MSTEST0010: ClassInitialize 方法应具有有效的布局

  • 项目
属性 值
规则 ID MSTEST0010
标题 ClassInitialize 方法应具有有效的布局
类别 使用情况
修复是中断修复还是非中断修复 非中断
默认为启用 是
默认严重性 警告
引入版本 3.3.0
有代码修复吗 是

原因

标记为 [ClassInitialize] 的方法应具有有效的布局。

规则说明

标记为 [ClassInitialize] 的方法应遵循以下布局才有效：

  • 无法在未设置 InheritanceBehavior 模式的情况下对泛型类声明它
  • 它应为 public
  • 它应为 static
  • 它不应为 async void
  • 它不应是特殊方法（终结器、运算符...）。
  • 它不应为泛型
  • 它应采用 TestContext 类型的一个参数
  • 返回类型应为 void、Task 或 ValueTask
  • 对于 InheritanceBehavior.BeforeEachDerivedClass 类，应指定 abstract 属性参数。
  • 对于 InheritanceBehavior.BeforeEachDerivedClass 类，不应指定 sealed 属性参数。

声明这些方法的类型还应遵循以下规则：

  • 类型应为 class。
  • class 应为 public 或 internal（如果测试项目正在使用 [DiscoverInternals] 属性）。
  • class 不得为 static。
  • 如果 class 为 sealed，则它应标记为 [TestClass]（或派生属性）。
  • 该类不应为泛型

如何解决冲突

确保该方法与上述布局匹配。

何时禁止显示警告

不禁止显示此规则发出的警告。 如果忽略此规则，则已标记的实例会被跳过或导致运行时错误。

抑制警告

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

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

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

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

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