魔术字符串/数字的用法

这是一个颇具争议的话题，我想与程序员一样多。但是，为此，我想知道业务（或您的工作场所）中的常见做法。

在我的工作场所，我们有严格的编码准则。其中一部分专门用于魔术字符串/数字。它指出（对于C＃）：

除了定义符号常量外，请勿在代码中使用数字或字符串的文字值。使用以下模式定义常量：

public class Whatever  
{  
   public static readonly Color PapayaWhip = new Color(0xFFEFD5);  
   public const int MaxNumberOfWheels = 18;  
}

有例外：几乎可以始终安全地使用值0、1和null。通常，值2和-1也可以。用于记录或跟踪的字符串不受此规则的限制。当文字的含义在上下文中很清楚且不受将来的更改时，允许使用文字。

mean = (a + b) / 2; // okay  
WaitMilliseconds(waitTimeInSeconds * 1000); // clear enough

理想的情况是在以下情况下一些官方研究论文对代码的可读性/可维护性产生影响：

• 魔术数字/字符串无处不在
• 魔术字符串/数字会被常量声明合理地替换（或在不同程度的覆盖范围内）-请不要因为使用“合理地”而对我大喊大叫，我知道每个人都有不同的想法，“合理地”是什么
• 魔术字符串/数字被多余地替换在不需要的地方（请参见下面的示例）

在与一位同事争论时，我希望这样做具有一些基于科学的论据，而后者将要声明常量，例如：

private const char SemiColon = ';';
private const char Space = ' ';
private const int NumberTen = 10;

另一个例子是（这是在JavaScript中）：

var someNumericDisplay = new NumericDisplay("#Div_ID_Here");

如果仅在1个地方使用DOM ID，您是否将DOM ID粘贴在JavaScript文件的顶部？

我阅读了以下主题：
StackExchange
StackOverflow
字节数IT社区
还有很多文章，阅读这些文章后，就会出现一些模式。

所以我的问题是在代码中使用魔术字符串和数字吗？我特意在寻找可能的参考文献支持的专家解答。

...与我的一位同事吵架时，谁将要声明常量，例如：

private const char SemiColon = ';';
private const char Space = ' ';
private const int NumberTen = 10;

您需要与同事讨论的论点不是关于将文字空间命名为，Space而是他为常数选择的名字很差。

假设您的代码的工作是解析记录流，这些记录流包含由分号（a;b;c）分隔并且由空格（a;b;c d;e;f）分隔的字段。如果撰写规范的人从现在起一个月后打电话给您，并说：“我们错了，记录中的字段用竖线符号（a|b|c d|e|f）分隔”，您该怎么办？

在您的同事喜欢的“按价值命名”方案下，您必须更改文字（SemiColon = '|'）的值，并使用继续SemiColon用于不再是分号的代码。这将导致代码审查中的负面评论。要消除这种情况，您可以将文字名称更改为，PipeSymbol并通过更改每次出现的方式SemiColon来更改PipeSymbol。以这种速度，您可能还应该首先使用文字分号（';'），因为您必须分别评估它的每次使用，并且要进行相同数量的更改。

为常数标识符需要是描述性的价值是什么呢，这个值不是是，那您的同事做了一个左转进入杂草的。在上述的字段拆分应用程序中，分号的用途是字段分隔符，应相应地命名常量：

private const char FieldSeparator = ';';    // Will become '|' a month from now
private const char RecordSeparator = ' ';
private const int MaxFieldsPerRecord = 10;

这样，当字段分隔符更改时，您只需更改一行代码，即常量的声明。看到更改的人只会看到那一行，并且会立即了解到，字段分隔符已从分号更改为管道符号。其余代码（由于使用了常量而无需进行更改）保持不变，并且读者不必深入研究它就可以做什么。

将分号定义为常数是多余的，因为分号本身已经是常数。它永远不会改变。

好像没有一天有人会宣布“术语更改，+现在是新的分号”，而您的同事会高兴地急于更新常数（他们嘲笑我-现在看看它们）。

还有一个一致性问题。我保证NumberTen不会为每个人使用他的常量（大多数编码人员都不在意），因此无论如何它都不会达到预期的目的。当末日降临并且“十”被全局重新缩放为9时，更新常量将无法解决问题，因为它仍然会10在代码中留下大量的文字s，因此即使在范围内，系统现在也变得完全不可预测一个革命性的假设，即“十”表示“ 9”。

将所有设置存储为const是我也要考虑的另一件事。一个人不应轻易做到这一点。

到目前为止，我们收集了哪些此类使用示例？线路终止器...最大重试次数...最大轮数...我们确定这些不会改变吗？

代价是更改默认设置需要重新编译应用程序，在某些情况下甚至需要重新编译其依赖项（因为数字const值可能在编译过程中被硬编码）。

还有测试和模拟方面。您已将连接字符串定义为const，但现在哎呀，您不能在单元测试中模拟数据库访问（建立伪连接）。

private const char SemiColon = ';';
private const char Space = ' ';
private const int NumberTen = 10;

因此，您的同事的目标是每日参加WTF。这些定义是愚蠢的和多余的。但是，正如其他人所指出的那样，以下定义不会是愚蠢的或多余的：

private const char StatementTerminator = ';';
private const char Delimiter = ' ';
private const int  BalanceInquiryCode = 10;

“魔术”数字和字符串是常量，其含义超出其立即的字面值。如果该常量的10含义超出“十件事”（例如，作为特定操作或错误条件的代码），则该常量变为“魔术”，应替换为描述该抽象含义的符号常量。

除了清楚地描述意图，符号常量还为您拼写错误的文字省去了一些麻烦。在一行代码中，从“ CVS”到“ CSV”的简单转换就一直进行单元测试和质量检查，并投入生产，从而导致特定操作失败。是的，很显然，单元测试和QA测试是不完整的，这是它自己的问题，但是使用符号常量可以完全避免这种胃灼热的感觉。

对此不应该有任何争议。关键不是要使用魔术数字，还是要具有可读的代码。
考虑之间的区别：if(request.StatusCode == 1)和if(request.HasSucceeded)。在这种情况下，我认为后者更具可读性，但这并不意味着您永远都不会拥有像这样的代码int MaxNumberOfWheels = 18。

PS：这就是为什么我绝对讨厌编码指南。开发人员应该足够成熟，能够做出这样的判断。他们不应该把它留给上帝知道谁的文本形成。