c# - SupressMessage 属性有什么用？

Question

我一直在研究 WPF 应用程序的几个源代码，并且到处都看到了 SupressMessage 属性。属性的描述现在对我来说非常模糊。 “抑制特定静态分析工具规则违规的报告，允许对单个代码工件进行多次抑制。”此属性有何用途及其实际用途？

Answer 1

当你申请code analysis对于您的项目，您有时会收到您想忽略的警告，因为警告是误报，或者因为代码的特定部分可以违反代码分析规则。

您可以使用 SuppressMessageAttribute 来做到这一点.现在，代码分析已内置到 Visual Studio 的“更高”SKU 中，但以前您必须使用名为 FxCop 的工具来执行分析。

一般来说，当您想忽略警告时，您有以下三种选择:

• 您可以从用于分析代码的规则集中删除规则。只有当你真的不关心规则时，你才应该这样做。

• 您可以使用 SuppressMessageAttribute 在通常名为 GlobalSuppressions.cs 的项目范围抑制文件中抑制警告。这将允许您在单个文件中维护所有抑制，但会有点难以将特定抑制与一段代码相关联。

• 您可以使用 SuppressMessageAttribute 抑制源文件中出现警告的地方。这在代码和抑制之间创建了一个清晰的链接，但也会在代码中散布额外信息。请注意，某些警告只能在全局抑制文件中抑制，因为它们与特定代码段无关。

当您单击代码分析警告上的操作 下拉菜单时，最后两个选项可直接在 Visual Studio 中使用。当您使用 SuppressMessageAttribute 忽略警告时，您可以为 Justification 提供一个值。这样做将使您和其他开发人员在以后的某个时间点能够及时了解警告被抑制的原因。

如果你因为代码中有一些特殊的单词或缩写而收到拼写警告，你可能不应该禁止警告，而是创建一个 custom code analysis dictionary为您的项目。

对代码进行代码分析不仅可以提高代码质量，而且您还可以在此过程中学到一些东西。