MSTEST0021:首选 Dispose 而非 TestCleanup 方法

属性
规则 ID MSTEST0021
标题 首选 Dispose 而非 TestCleanup 方法
类别 设计
修复是中断修复还是非中断修复 非中断
默认已启用
默认严重性 信息
引入版本 3.4.0
是否存在代码修补程序 是的,从 3.7.0 开始

原因

当存在失效 [TestCleanup] 方法时,此规则会引发诊断,如果目标框架支持 [TestCleanup] 接口,则会在任何 IAsyncDisposable 上引发诊断。

规则说明

使用 DisposeDisposeAsync 是一种更常见的模式,一些开发人员宁愿始终将此模式用于测试。

如何解决冲突

[TestCleanup] 方法替换为 DisposeDisposeAsync 模式。

何时禁止显示警告

如果你决定选择遵循此规则,则通常不希望禁止显示此规则的警告。

禁止显示警告

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

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

若要禁用文件、文件夹或项目的规则,请将其严重性设置为 配置文件中的 none

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

有关详细信息,请参阅 如何取消代码分析警告