c++ - 文字的使用，在 C++ 中是/否

Question

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

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

假设您有一个 if 语句来检查存储在(为了论证)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，假设是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;

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

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

Answer 1

Which is the "preferred" method in terms of good coding practice? I can fully understand why you would prefer version 2 if kSuperDescriptiveVarName is used more than once.

听起来您理解了要点……在多个地方使用的因式分解值(及其注释)。此外，有时将一组常量放在一个地方会有所帮助 - 因此可以检查、验证、修改它们的值，而无需关心它们在代码中的使用位置。其他时候，附近会使用许多常量，正确解释它们所需的注释会混淆使用它们的代码。

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

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

Also, does the compiler do any optimizations to make both versions effectively the same executable code? That is, are there any performance implications here?

优化代码不会影响性能。

I fully understand that using sizeof versus a raw literal is preferred for portability and also readability concerns.

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

Which is preferred [for calculating offsets in a struct]? Does is still make sense to show all the steps involved with computing the offset or does the literal usage make sense here?

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

忽略 offsetof 问题，只考虑您的this + that 示例作为要分配的更复杂值的说明，这又是一种平衡行为。你肯定想要一些解释/评论/文档在这里重新意图(你正在计算早期字段的二进制大小吗？计算下一个字段的偏移量？，故意遗漏一些可能不需要的字段用于预期用途或者是那个意外？...)。不过，一个命名常量可能足以提供文档，因此您倾向于哪种方式可能并不重要....