变量名的力量

本章主要适用于为变量、对象和基本数据命名,也适用于为类、包、文件以及其他的编程实体命名。

1 选择好变量名的注意事项

变量和变量名是不同的东西,本质而言却是同一事物。变量的好与坏在很大程度上取决于它的命名的好坏。在给变量命名的时候需要小心谨慎。

一个不良变量名的例子

1.1 最重要的命名注意事项

1.2 以问题为导向

1.3 最适当的名字长度

1.4 作用于对变量名的影响

1.5 变量名中的计算值限定词

1.6 变量名的常用对仗词

2 为特定类型的数据命名

2.1 为循环下标命名

循环是一种极为常见的计算机编程特征。i、j 和 k 这些名字都是约定俗称的:

// Java示例:简单的循环变量名
for (i = firstItem; i < lastItem; i++) {
    data[i] = 0;
}

如果一个变量名要在循环之外使用,那么就应该为它取一个比 i、j 或 k 更有意义的名字。 例子:如果你在文件中读取记录,并且需要记下所有读取记录的数量,那么类似 recordCount 这样的名字就很合适。

// Java示例:描述性较好的循环变量名
// 读取记录的数量
recordCount = 0;
while (moreScores()) {
    score[recordCount] = GetNextScore();
    // 增加读取记录的数量
    recordCount++;
}
// 继续使用读取记录的数量
// lines using recordCount.
...

2.2 为状态变量命名

2.3 为临时变量命名

2.4 为布尔变量命名

2.5 为枚举类型命名

3 命名规则的力量

4 非正式命名规则

5 标准前缀

6 创建具备可读性的短名字

7 应该避免的名字