常量和单位的命名规范

Question

我的常量名称是否应该包含其表示的单位，还是通过简短的注释更好处理？有时常量名称可能会变得很长。例如，我可以在以下选项之间选择：

// Seconds spent displaying logo
public static final float LOGO_DISPLAY_TIMER = 1.5f;

和

public static final float LOGO_DISPLAY_TIMER_IN_SECONDS = 1.5f;

我一直在阅读《代码整洁之道》，这本书非常注重准确的命名规范，但我对这个具体情况不太确定。

- Cabbage soup

---

你是从零开始开发代码还是添加到现有的代码库？如果是后者，约定是什么？ - rajah9

我不知道关于变量名中“单位”的约定是否存在，但格式约定的整个目的是为了提高代码可读性。如果你的变量名变得过长以至于阅读难度增加，那么无论它们如何明确地规定某个规则，约定是否合适都值得怀疑。一个变量应该从其名称描述其用途，看起来你在第一个案例中已经做到了这一点。一致性很重要，其他所有内容次之。 - initramfs

@rajah9 我基本上是从零开始，但其他人将来会继续开发这个代码库，所以我打算为自己建立一些规范，使得代码对他们和我自己都尽可能易读。 - Cabbage soup

我所在的组织惯例是使用较短的名称，让下一个开发人员来确定单位。对于您的计时器示例，您的注释和1.5的比例非常易读。另一种情况是，如果您在注释中说“毫秒”，而常量为1500，则会有所不同。 - rajah9

如果你在为自己编写代码，应该使用你认为最好的方式，但更重要的是始终在整个代码中使用相同的约定，否则可能会变得混乱不堪。 - JNevens

Answer 1

在我看来，如果你的公司没有代码规范或类似的东西，那就采用你喜欢和感觉舒适的方式。最重要的是要保持一致，并始终使用相同的风格。

- Andre Hofmeister

Answer 2

使用较长的变量名的优点是您无需检查命令即可知道该变量属于哪个单元。缺点当然是它更长 :)

因此，正如之前提到的那样 - 选择您喜欢的方式并保持一致。

- bartektartanus