关闭

编码风格一:如何取好变量名

778人阅读 评论(0) 收藏 举报
代码的可读性好坏,会影响到程序员编写和维护代码的过程。如果把人的大脑看作计算机 CPU 加上内存的结合。那么,需要人去猜测的变量名、没有良好组织结构的代码、混乱的布局,对于阅读代码的人来说,总会消耗过多的大脑资源。而这些资源和精力应该放在程序原则正在关心的业务上。
下面,我们先来看看程序的一些命名规则。


1、变量名应该完全、准确的描述该变量所代表的事物

a、不是通用或者约定俗成的缩写。不要用简写替代变量名。如将 userinfo 写成 u 或者 ui 或者 uInfo。阅读代码时,类似的名字需要读者思考的时候绕两个弯子,甚至需要 Debug 或者联系上下文才能明白变量名的意思。
b、大多数情况下,不要使用 user1、user2 来表示同一程序中不同的变量。这样阅读代码的人就无法区分两个变量的不一样的地方。
c、不要使用中文甚至中文缩写命名变量名。
d、通常情况下,不要使用动词作为变量名。



2、好的变量名反映的都是问题,而不是解决方案。表达的是 what,而不是 how。

一条员工数据记录可以称为 inputRecord 或者 employeeData。inputRecord 是一个反映输入、记录这些计算机概念的术语。employeeData 则能让人直接联想到相关业务场景,与计算无关。


3、变量名的长度

相关研究发现,当程序里的变量名的平均长度在10到16个字符之间的时候,调试程序所需花费的力气是最小的。
如下图,感受下不同的变量名给人的感觉。

这里是一些缩短变量名的指导原则。
1、使用标准的缩写(如 rpt)。
2、去掉虚词 and,or,the。
3、使用名字中的每一个重要单词,最多不超过3个。
4、去掉无用的后缀(如 ing、ed 等)。
5、确保不要改变变量的含义。
6、不要从每个单词中删除一个字符的方式来缩写。
7、缩写要一致:如果将 function 缩写成 func。那么将整个项目里,最好都统一使用这种缩写。


4、为特定的变量命名

a、为状态变量取一个比 flag 更好的名字。如用 reportType 而不是 flag 作为变量名。
b、临时变量不要使用 temp。
c、为布尔变量命名。done、error、found、success 在具体的场景下,都是很有用的变量名。而 sourceFile 是很糟糕的变量名,因为他没有明确的 true 或者 false。if(found) 的可读性要高于 if(isFound)。

参考资料:《代码大全》

0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:10218次
    • 积分:255
    • 等级:
    • 排名:千里之外
    • 原创:11篇
    • 转载:7篇
    • 译文:0篇
    • 评论:6条
    最新评论