11.1 选择好变量名的注意事项
变量和变量名就本质而言是同一事物.
变量的好与坏决定于它的命名的好坏.
一个好的变量名是可读的,易记的和恰如其分的.
最重要的命名注意事项
该名字是否能完全,准确地描述出该变量所代表的事物.
容易阅读,其中不包含晦涩的缩写,同时没有歧义.因为它是对该事物的完整描述.
以问题为导向
一个好名字通常表达的是"什么",而不是"如何how"
如果一个名字反映了计算的某些方面而不是问题本身,那么它反映的就是how了.
一条员工数据可命名为inputRec(反映输入)或employeeData(直指问题领域)
在财务软件,calcVal的计算痕迹比sum更明显
最适当的名字长度
- 太短的名字无法传达足够的信息
- 太长的名字很难写,同时也会使程序的视觉结构变得模糊不清.
变量名对作用域的影响
短变量名i,代表的是一个临时的数据,它的作用域非常有限.
较长的名字适用于很少用到的变量或者全局变量
而较短的名字则适用于局部变量或者循环变量.
变量名中的计算值限定词
限定词:Total,Sum,Average,Max,Min,Record,String
计算结果的变量:总额,平均值,最大值
把限定词加到名字的最后
优点:
- 突出主要含义的部分
- 具有对称性,提高可读性
变量名中的常用对仗词
- begin/end
- first/last
- locked/unlocked
- min/max
- next/previous
- old/new
- opened/closed
- visible/invisible
- source/target
- source/destination
- up/down
优点:容易理解和记忆,提高可读性
11.2 为特定类型的数据命名
在为数据命名的时候,除了通常的考虑事项之外,为一些特定类型的数据的命名还要求做出一些特殊的考虑.
网友评论