一:选择好变量名的注意事项
注:一个好的变量名是可读的,易记的和恰如其分的,你可以通过应用多条原则来实现这些目标。
1.变量名要完全、准确地描述出该变量所代表的事物。技巧:用文字表达变量所代表的是什么。通常,对变量的描述就是最佳的变量名。
2.使用数字的变量名如:x1,x2,x3永远是坏名字。
3.变量名的平均长度在10到16个字符或者9到15个字符的时候,调试程序所需花费的力气是最小的。它项原则强调的是,如果你在查看代码的时候,发现了很多更短的名字,那么你就需要认真检查,确保这些名字含义足够清晰。
4.技巧:较长的名字适用于很少用到的变量或者全局变量,而较短的名字则适用于局部变量或者循环变量。尽量避免使用短的变量名。
5.限定词的使用:像 Total,Sum,Average,Max,Min,Record,String,Pointer这样的限定词来修饰某个名字,那么请记住把限定词加到名字的最后。注:将变量名中最重要的部分,即为这一变量赋予主要含义的部分应当位于最前面。例外:Num 限定词的位置是约定俗成的。Num 放在变量名的开始位置代表一个总数,Num放在变量名的结束位置代表一个下标,尽量避免使用这种容易使人混淆的命名方式。可以使用Count或者Total来代替。
6.变量名中常用的对仗词:begin/end first/last locked/unlocked min/max next/previous old/new opened/closed visible/invisible source/target up/down...
二:为特定类型的数据命名
1.为循环变量命名。i j k等常用于单层循环,如果是多个嵌套循环,那就应该给循环变量赋予更长的名字以提高可读性,否则有产生下标串话的常见问题:想用i的时候写成了j,想用j的时候写成了i。
2.为状态变量命名。为状态变量取一个比flag更好的名字。可以结合枚举类型和预定义常量名来为状态变量命名。
3.如果你发现自己需要猜测某段代码的含义的时候,就该考虑为变量重新命名。最好的效果是能直接读懂他们!
4.为临时变量命名。应该时刻警惕临时变量,像temp,x...尽量使用准确而且具有描述性的变量名。
5.为布尔变量命名。典型例子:done 表示某件事已经完成。error 表示有错误发生。success或ok 表明一系列操作是否成功。避免使用status和statusFile等糟糕的变量名。
6.为枚举类型命名。最常用的方法就是使用组前缀。例:Color_...,Planet_...
7.为常量命名。应该根据该常量所表示的含义,多用大写,使用下划线连接起来。
三:命名规则的力量
应该遵循规则
四:应该避免的名字
1.避免使用令人误解和名字或缩写。尽量避免和关键字类似或者和其他变量名相似。
2.避免使用发音相似的名字。
3.避免在名字中使用数字。
4.避免在名字中拼错单词。
5.不要仅靠大小写来区分变量名。
6.避免使用多种语言。
7.避免使用标准类型,变量和子程序的名字。
8.不要使用与变量含义完全无关的名字。
9.避免在名字中包含容易混淆的字符。
总结:好的变量名能提高程序的可读性。名字要能做到见名知意。