我應該壓制CA2204：文字應拼寫正確嗎？

Question

我最近將項目從Visual Studio 2008升級到Visual Studio 2010.

通過啓用代碼分析，我得到了許多警告導致規則CA2204：文字應該拼寫正確。

編輯：

比方說，我有一個名爲GetResult()方法，並在這我想扔出於某種原因的異常。我想例外地說"GetResult() has failed for some reason"。由於GetResult不是一個單詞，這會給我警告。我不會在方法名GetResult()上發出警告，只有當我把它放在一個字符串中。這是因爲獲取和結果是合法的詞彙。

我不認爲寫作GetResult() has failed for some reason是解決方案。

EDIT：在MSDN它說：

此規則解析文字串 成單詞，令牌化複合詞， 和檢查每個 字/令牌的拼寫。

這並不意味着GetResult應該被檢查爲兩個單詞：「Get」和「Result」？

我應該抑制CA2204嗎？

Answer 1

"Can't initialize MyClass"對於開發人員來說不是一個很好的消息來引入代碼。它很少有助於調試，只會在最終用戶顯示時混淆最終用戶。

一般來說，我會說不要壓制信息，因爲拼寫錯誤讓人看起來比他們真正的笨多了，這不是你想要用你的應用程序傳遞的信息。

在這種具體情況下，這真是一個可憐的錯誤消息的警告 - 要麼告訴用戶如何糾正它，自動更正，或包括它不是在錯誤日誌初始化的實際原因。

編輯：包括OP的編輯
東西你可以從這個警告是，你不應該透露的代碼細節的錯誤信息（主要是因爲它們將包含在您登錄時調用堆棧的一部分例外）。

GetResult() has failed for some reason
讓我們說「某些原因」是權限。該消息可能爲：

您沒有查看這些結果的權限。

沒有必要提及失敗的具體方法，因爲可以自動記錄堆棧跟蹤。

Answer 2

可能是你不應該把類名字變成​​文字？怎麼樣使用或定義異常，可以拋出這樣的：

throw new CantInitializeClassException(innerException, typeof(MyClass); 

我的想法是，以瞭解更多信息移動到更從籠統的更具體的例外。我建議使用上面的示例代替throw new ApplicationException("Cant initialize MyClass");

Answer 3

解決此問題的一種方法是不要直接將類型名稱添加到字符串中。而是將其作爲參數傳遞。例如，

var msg = String.Format("Can't initialize {0}", typeof(MyClass).Name); 

這有利於避免FxCop規則和安全重構。

Answer 4

CA2204全是關於拼寫。不幸的是，即使在VS2012中，它仍然存在一個令人討厭的bug，它無法標記複合詞：http://connect.microsoft.com/visualstudio/feedback/details/521030

這導致我在代碼分析規則集中關閉此規則。