1

我最近听说在某些情况下，程序员认为你永远不应该在代码中使用文字。我知道在某些情况下，将变量名称分配给给定的数字可能会有所帮助（特别是在维护方面，如果该数字在其他地方使用）。但是，请考虑以下案例研究：

案例研究 1：将文字用于“特殊”字节码。

假设您有一个 if 语句检查存储在（为了论证） a 中的特定值uint16_t。以下是两个代码示例：

版本 1：

// Descriptive comment as to why I'm using 0xBEEF goes here
if (my_var == 0xBEEF) {
  //do something
}

版本 2：

const uint16_t kSuperDescriptiveVarName = 0xBEEF;
if (my_var  == kSuperDescriptiveVarName) {
  // do something
}

就良好的编码实践而言，哪种方法是“首选”方法？kSuperDescriptiveVarName如果多次使用，我完全可以理解为什么您更喜欢版本 2 。此外，编译器是否进行任何优化以使两个版本有效地成为相同的可执行代码？也就是说，这里有任何性能影响吗？

案例研究 2：使用sizeof

我完全理解，出于可移植性和可读性的考虑，使用 sizeof 与原始文字相比是首选。考虑这两个代码示例。场景是您正在计算数据包缓冲区（一个数组uint8_t）中的偏移量，其中数据包的第一部分存储为my_packet_header，假设是 a uint32_t。

版本 1：

const int offset = sizeof(my_packet_header);

版本 2：

const int offset = 4;  // good comment telling reader where 4 came from

显然，版本 1 是首选，但是对于有多个数据字段要跳过的情况呢？如果您有以下内容怎么办：

版本 1：

const int offset = sizeof(my_packet_header) + sizeof(data_field1) + sizeof(data_field2) + ... + sizeof(data_fieldn);

版本 2：

const int offset = 47;

在这种情况下哪个是首选？显示计算偏移量所涉及的所有步骤是否仍然有意义，或者文字用法在这里有意义吗？

在我尝试改进我的代码实践时提前感谢您的帮助。

4

4 回答 4

3

就良好的编码实践而言，哪种方法是“首选”方法？如果 kSuperDescriptiveVarName 被多次使用，我完全可以理解为什么你会更喜欢版本 2。

听起来您理解了要点......在多个地方使用的因子值（及其注释）。此外，有时将一组常量放在一个地方会有所帮助——因此可以检查、验证、修改它们的值等，而不必担心它们在代码中的使用位置。其他时候，有许多常量在附近使用，正确解释它们所需的注释会混淆使用它们的代码。

反驳这一点，拥有一个const变量意味着所有研究代码的程序员都会想知道它是否在其他任何地方使用过，在他们检查声明它的范围的其余部分时牢记这一点 - 记住的不必要的东西越少，就越可靠将理解代码的重要部分。

就像编程中的许多事情一样，它是平衡每种方法的利弊的“一门艺术”，最好以代码可能被研究、维护和发展的方式的经验和知识为指导。

此外，编译器是否进行任何优化以使两个版本有效地成为相同的可执行代码？也就是说，这里有任何性能影响吗？

优化的代码没有性能影响。

我完全理解，出于可移植性和可读性的考虑，使用 sizeof 与原始文字相比是首选。

还有其他原因。良好编程的一个重要因素是在更改完成后减少维护点。如果您可以修改变量的类型并且知道使用该变量的所有位置都会相应地进行调整，那就太好了——节省时间和潜在的错误。使用sizeof有助于解决这个问题。

哪个是首选[用于计算结构中的偏移量]？显示计算偏移量所涉及的所有步骤是否仍然有意义，或者文字用法在这里有意义吗？

offsetof宏 ( #include <cstddef>) 更适合这个...再次减少维护负担。使用您说明的this + that方法，如果编译器决定使用任何填充，您的偏移量将是错误的，并且您必须在每次添加或删除字段时修复它。

忽略 offsetof 问题，只考虑您的this + that示例作为分配更复杂值的说明，这又是一种平衡行为。您肯定希望在这里重新获得一些解释/评论/文档的意图（您是否在计算早期字段的二进制大小？计算下一个字段的偏移量？故意遗漏一些可能不需要用于预期用途的字段或那是偶然的吗？...）。尽管如此，一个命名的常量可能就足够了，所以你倾向于哪种方式可能并不重要......

于 2013-06-14T05:00:28.370 回答
2

在您列出的每个示例中，我都会使用名称。

在您的第一个示例中，您几乎可以肯定至少两次使用了那个特殊的 0xBEEF 数字 - 一次编写它，一次进行比较。如果不是你写的，这个数字仍然是与其他人签订的合同的一部分（可能是文件格式定义）。

在最后一个示例中，显示产生该值的计算特别有用。这样，如果您遇到麻烦，您可以轻松查看该号码是否值得信赖，或者您错过了什么并修复它。

不过，在某些情况下，我更喜欢文字而不是命名常量。在这些情况下，名称并不比数字更有意义。例如，您有一个玩骰子游戏（可能是 Yahtzee）的游戏程序，其中有针对特定掷骰的特定规则。您可以为 One = 1、Two = 2 等定义常量。但何必呢？

于 2013-06-14T05:02:23.720 回答
1

通常最好使用名称而不是值。毕竟以后如果需要改的话，找起来也比较方便。此外，当您阅读代码时，并不总是清楚为什么要使用这个特定的数字，因此为其分配一个有意义的名称，可以让程序员立即明白这一点。

性能方面没有区别，因为优化器应该照顾它。即使会生成额外的指令，这也不太可能给您带来麻烦。如果您的代码如此紧凑，那么您可能无论如何都不应该依赖优化器效果。

于 2013-06-14T04:45:39.680 回答
0

如果 kSuperDescriptiveVarName 被多次使用，我完全可以理解为什么你会更喜欢版本 2。

我想kSuperDescriptiveVarName肯定会不止一次使用。一个用于检查，至少一个用于分配，可能在您程序的不同部分。

性能上不会有任何差异，因为Constant Propagation几乎所有编译器中都存在一种称为优化的方法。只需为您的编译器启用优化。

于 2013-06-14T04:55:14.580 回答