MSTEST0025:使用“Assert.Fail”而不是始终失败的断言

属性
规则 ID MSTEST0025
标题 使用“Assert.Fail”而不是始终失败的断言
类别 设计
修复是中断修复还是非中断修复 非中断
默认为启用
默认严重性 信息
引入版本 3.4.0
是否存在代码修补程序

原因

当对断言的调用生成始终为 false 的条件时,此规则会引发诊断。

规则说明

使用 Assert.Fail 而不是始终失败的断言可以让代码的意向更清晰,文档更完善。

遇到始终失败的断言(例如 Assert.IsTrue(false))时,阅读代码的人可能不会立即明白该断言为何存在,或者它试图检查什么条件。 这可能会导致以后遇到代码的开发人员感到困惑和浪费时间。

相比之下,使用 Assert.Fail 可以提供自定义失败消息,明确断言失败的原因以及它所解决的特定条件或方案。 此消息充当断言背后的意向文档,帮助其他开发人员了解断言的目的,而无需深入了解代码。

总的来说,使用 Assert.Fail 可提升代码库的清晰度、文档化和可维护性,使其成为比始终失败的断言调用更好的选择。

如何解决冲突

确保对 Assert.IsTrueAssert.IsFalseAssert.AreEqualAssert.AreNotEqualAssert.IsNullAssert.IsNotNull 的调用不会产生始终失败的条件。

何时禁止显示警告

建议不要禁止显示此规则的警告。

禁止显示警告

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

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

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

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

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