1.最重要的考虑事项
该名字要完全、准确地描述出该变量所代表的事物。获得好名字的一种实用技巧就是用文字表达变量所代表的是什么。通常,对变量的描述就是最佳的变量名。这种名字很容易阅读,因为其中并不包含晦涩的缩写,同时也没有歧义。因为它是对该事物的完整描述,因此不会和其他事物混淆。另外,由于这一名字与所表达的概念相似,因此也容易记忆。
变量名应该尽可能地明确。像x、temp、i这些名字都可以泛泛的表达多种目的,没有提供足量的信息的变量名通常是坏的名称。
2.以问题为导向
一个好记的名字反映的通常都是问题,而不是解决方案,一个好名字通常表达的是“什么”(what),而不是“如何”(how)。
3.最适当的名字长度
当变量名的平均长度在10到16个字符的时候,调试程序所需花费的气力是最小的,。平均名称长度在8到20个字符的程序也几乎同样容易调试。这项原则并不意味着你应该尽量把变量名控制在9到15或者10到16个字符长,它强调的是,如果你查看自己写的代码时发现了很多更短的名字,那么你需要认真检查,确保这些名字含义足够清晰。
4.变量名中的计算值限定词
一些计算结果变量如:总额、平均值、最大值等可以用类似于Total、Sum、Average、Max、Min、Record、Pointer这样的限定词命名,优点:突出、明了;避免歧义;放在不同位置代表不同含义。
5.常用对仗词
对仗词使用要准确,提高可读性
begin/end;first/last;locked/unlocked;min/max;next/previous;old/new;opened/closed;visible/invisible;source/target;source/destination;up/down
6.语义前缀
| 语义前缀 | 含义 |
|---|---|
| c | 数量(count,如记录、字符或者其他东西的个数) |
| first | 数组中需要处理的第一个元素。first与min类似,但它是相对于当前操作而不是数组本身的 |
| g | 全局变量(global variable) |
| i | 数组的下标(index into an array) |
| last | 数组中需要处理的最后一个元素 |
| lim | 数组中需要处理的元素的上限 |
| m | 类一级的变量 |
| max | 数组或者其他种类的列表中绝对的最后一个元素。max反映的是数组本身,而不是针对数组的操作 |
| min | 数组或者其他种类的列表中绝对的第一个元素 |
| p | 指针 |
7.应该避免的名字
避免使用令人误解的名字或缩写;避免使用具有相似含义的名字;避免使用具有不同含义但却有相似名字的变量。
Key Points
(1)好的变量名是提高程序可读性的一项关键要素。对特殊种类的变量,比如循环下标和状态变量,需要加以特殊的考虑;
(2)名字要尽可能地具体,那些太模糊或者太通用以至于能够用于多种目的的名字通常都是很不好的;
(3)命名规则应该能够区分局部数据、类数据还是全局数据,它们还应当可以区分类型名、具名常量、枚举类型名字和变量名;
(4)无论做哪种类型的项目,你都应该采用某种变量命名规则。你所采用的规则的种类取决于你的程序的规模,以及项目成员的人数。
(5)尽量不要用缩写,真的要用的话,请使用项目缩写词典或者标准前缀来帮助理解缩写;
(6)代码的阅读次数远远多于编写的次数,确保你取的名字更侧重于阅读方便而不是编写方便。


被折叠的 条评论
为什么被折叠?



