我应该压制CA2204:文字应拼写正确吗？

Question

我最近将我的项目从Visual Studio 2008升级到Visual Studio 2010.

通过启用代码分析,我收到了很多警告,导致规则CA2204:文字应拼写正确.

编辑:

假设我有一个调用的方法GetResult(),并且在其中我想出于某种原因抛出异常.我想要例外说"GetResult() has failed for some reason".这将给我警告,因为GetResult不是一个字.我不会在方法名称上收到警告GetResult(),只有当我把它放在一个字符串中时.这是因为Get和Result是合法的词.

我不相信写作GetResult() has failed for some reason是解决方案.

编辑:在MSDN中它说:

此规则将文字字符串解析为单词,标记复合词,并检查每个单词/标记的拼写.

这是否意味着应该将GetResult检查为两个词:"获取"和"结果"？

我应该抑制CA2204吗？

Answer 1

"Can't initialize MyClass"对于开发人员引入代码来说,这不是一个好消息.它很少有助于调试,它只会在最终用户显示时混淆.

一般来说,我会说不要压制消息,因为拼写错误让人看起来比实际上要笨重,而且这不是你想用你的应用传达的信息.

在这个特定的实例中,它实际上是一个错误消息的警告 - 要么告诉用户如何纠正它,自动纠正它,要么包括它没有在错误日志中初始化的实际原因.

编辑: 包括OP的编辑
您可以从此警告中获取的一点是,您不应该在错误消息中显示代码详细信息(主要是因为它们将在您记录异常时包含在调用堆栈中).

GetResult() has failed for some reason
让我们说"某些原因"是权限.该消息可以是:

您无权查看这些结果.

无需提及失败的特定方法,因为可以自动记录堆栈跟踪.