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

原创 2015年07月09日 10:08:06
代码的可读性好坏,会影响到程序员编写和维护代码的过程。如果把人的大脑看作计算机 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)。

参考资料:《代码大全》

谈谈良好的编码风格

能写出结构精巧的代码是一件令人羡慕的事情,能写出解决复杂问题模型的算法是一件令人羡慕而又佩服事情。虽然未必所有人能做到这些,但是每一个对代码有信仰的人至少要做到语法使用合理、代码简洁、逻辑清晰、变量的...
  • lanyuxinkong
  • lanyuxinkong
  • 2015年08月27日 16:26
  • 1730

Python 如何根据变量得到变量名

应用场景:https://github.com/gt11799/Direcited_graph
  • gt11799
  • gt11799
  • 2014年09月04日 23:04
  • 1796

2.存储过程的变量

来源:网易云课堂《精通MySQL存储过程、函数和触发器》课程 讲师:huangxifeng607 笔记:...
  • wubinyu
  • wubinyu
  • 2017年10月07日 13:42
  • 70

变量名的力量

曾经在网上看到的一句话:“一个好的程序员往往不需要添加过多的注释,因为他编写的代码就是注释。“一个好的变量名是可读的,易记的和恰如其分的。 如何才能称为好的变量呢?好的变量应该有如下两个特征: 1...
  • u013564742
  • u013564742
  • 2015年10月28日 20:30
  • 329

oracle之存储过程4-存储过程变量的使用

1.存储过程基本结构。从is到begin区域为声明变量区域,从bengin到end区域为逻辑代码区域。 创建变量并赋值。创建变量时需要指定取值范围。 变量名 := 值; x ...
  • u010662668
  • u010662668
  • 2017年03月13日 15:21
  • 91

编码风格(一)

1.格式化 ctrl+shift+f 2.日志记录 log 3.对于表的查询操作加上onclock SELECT d.userCode,d.birthda...
  • u010408365
  • u010408365
  • 2015年05月06日 13:56
  • 283

C#编码风格小总结

最近连续使用了3个月时间的C#,对C#的类库基本可以驾轻就熟的应用了,在这段时间里也总结出了合适的编程风格,最近刚刚写完了一个网络状态监测的小程序,自认为风格可以代表自己的编程风格,主要单元全部贴出来...
  • wikiccc
  • wikiccc
  • 2014年01月23日 23:39
  • 847

谷歌公司的C++编码风格

1. 头文件¶   通常每一个 .cc 文件都有一个对应的 .h 文件. 也有一些常见例外, 如单元测试代码和只包含 main() 函数的 .cc 文件.  正确使用头文件可令代码在可读性、文件...
  • Bro_J
  • Bro_J
  • 2017年03月15日 18:10
  • 299

Android编码规范风格指导(翻译)

原文地址:http://source.android.com/source/code-style.html 有很多为Android开源社区贡献代码的程序员,每个人都有不同的代码风格,为此googl...
  • leirenbaobao
  • leirenbaobao
  • 2015年04月28日 21:00
  • 773

asp.net中如何利用反射获取动态变量名称

网上载的,简单使用。 反射获取dbConn类中的方法 public static SqlConnection GetConnection(string id)//创建连接,由参数决定调用哪个连接字...
  • fox123871
  • fox123871
  • 2011年08月10日 11:05
  • 1362
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:编码风格一:如何取好变量名
举报原因:
原因补充:

(最多只允许输入30个字)