Debug.Assert -s 使用相同的错误消息。我应该将其提升为静态变量吗？

Question

我喜欢断言和代码可读性，但不喜欢代码重复，并且在几个地方我使用 Debug.Assert 来检查相同的条件，如下所示：

Debug.Assert(kosherBaconList.SelectedIndex != -1, "An error message along the lines - you should not ever be able to click on edit button without selecting a kosher bacon first.");

这是对实际错误的响应，尽管实际列表不含犹太培根。无论如何，我可以想到两种方法：

private static readonly mustSelectKosherBaconBeforeEditAssertMessage = 
    "An error message along the lines - you should not ever be able to " +
    "click on edit button without selecting a something first.";
...
Debug.Assert(
    kosherBaconList.SelectedIndex != -1, 
    mustSelectKosherBaconBeforeEditAssertMessage)

或者：

if (kosherBaconList.SelectedIndex == -1)
{
    AssertMustSelectKosherBaconBeforeEdit();
}
...
[Conditional("DEBUG")]
private void AssertMustSelectKosherBaconBeforeEdit()
{
    // Compiler will optimize away this variable.
    string errorMessage = 
        "An error message along the lines - you should not ever be able to " +
        "click on edit button without selecting a something first.";

    Debug.Assert(false, errorMessage);
}

或者是否有第三种方法比上面任何一种方法都少？请分享。 也欢迎一般有用的相关提示。

Answer 1

使用第一种（重复）形式。

原因是：

• 工作量减少了。断言仅用于调试，因此重复不会给发布版本带来任何低效率。当代码已经具有完美的可读性和功能时，不要浪费时间试图使代码“漂亮”或“优雅”。

• 我认为它实际上比您的替代方案更短、更具可读性并且更容易维护。

• 当您在调试器中点击断言时，在代码中包含完整消息非常有用，这样您就可以了解断言的含义。很多程序员使用 Assert(kosherBaconList.SelectedIndex != -1);根本没有任何解释，如果你编写了代码，这很好，但是当你点击别人的断言时，你不知道它意味着什么。也就是说，我知道我称你的方法为“错误”，但我到底需要修复什么才能称其为“正确”？因此，断言消息应该指出问题是什么，以及盯着 Assert() 调用的人需要做什么来修复它。当调试器在测试运行中停止时，您希望它就在您面前。

• 有时您会发现添加与触发断言的上下文相关的附加信息很有用，因此您不必实际调试代码来确定 3 个“相同”断言中哪一个失败了。为此，我经常使用断言文本，例如“BaconManager.Cook：您必须选择...”和“BaconManager.Wrap：您必须选择...”。

• 如果您在 Assert 调用中包含文本，它将不会被编译到您的发布版本中。但是，一旦将其设为静态变量，您就会在发布版本中包含（未使用的）字符串，从而用调试垃圾堵塞它。

如果您想检查多个条件来测试对象的有效性，则可以使用子例程，即

[Conditional("DEBUG")] 
private void AssertValidity() 
{ 
    Debug.Assert(kosherBaconList.SelectedIndex != -1, "Nothing selected in kosher bacon list"); 
    Debug.Assert(kosherBaconList.COunt > 0, "kosher bacon list is empty!"); 
} 

Answer 2

保持简单，我会选择static MustSelectKosherBaconBeforeEditAssertMessage = " "。如果存在一些细微的差异，甚至可能对于内联字符串也是如此。

您的 AssertMustSelectKosherBaconBeforeEdit() 看起来太像过早/微观优化。

Answer 3

还有一个建议：不要使用静态变量，而是将其设为：

private const string mustSelectKosherBaconBeforeEditAssertMessage = 
    "An error message along the lines - you should not ever be able to " +
    "click on edit button without selecting a something first.";

有关 const 与 static readonly 的更多信息： 链接

不同之处在于 a 的值
静态只读字段在运行时设置
时间，因此可以通过
包含类，而值
const 字段设置为编译时
常数。

也在这里：
http://msdn.microsoft.com/en-us/magazine/cc300489。 ASPX