编程规范 --- 可读性
2016-06-04 14:05
225 查看
1:注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
说明:防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。示例:下列语句中的表达式
word = (high <<8) | low (1)
if ((a | b)&& (a & c)) (2)
if ((a | b) < (c& d)) (3)
如果书写为
high << 8 | low
a | b && a& c
a | b < c & d
由于
high << 8 | low= ( high << 8) | low,
a | b && a& c = (a | b) && (a & c),
(1)(2)不会出错,但语句不易理解;
a | b < c & d= a | (b < c)& d,(3)造成了判断条件出错。
2:避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。
示例:如下的程序可读性差。if(Trunk[index].trunk_state == 0)
{
Trunk[index].trunk_state = 1;
... // program code
}
应改为如下形式。
#define TRUNK_IDLE 0
#define TRUNK_BUSY 1
if(Trunk[index].trunk_state == TRUNK_IDLE)
{
Trunk[index].trunk_state = TRUNK_BUSY;
... // program code
}
3:源程序中关系较为紧密的代码应尽可能相邻。
说明:便于程序阅读和查找。示例:以下代码布局不太合理。
rect.length = 10;
char_poi = str;
rect.width = 5;
若按如下形式书写,可能更清晰一些。
rect.length = 10;
rect.width = 5; // 矩形的长与宽关系较密切,放在一起。
char_poi = str;
4:不要使用难懂的技巧性很高的语句,除非很有必要时。
说明:高技巧语句不等于高效率的程序,实际上程序的效率关键在于算法。示例:如下表达式,考虑不周就可能出问题,也较难理解。
* stat_poi ++ += 1;
* ++ stat_poi += 1;
应分别改为如下。
*stat_poi += 1;
stat_poi++; // 此二语句功能相当于“ * stat_poi ++ += 1; ”
++ stat_poi;
*stat_poi += 1; // 此二语句功能相当于“ * ++ stat_poi += 1; ”
相关文章推荐
- 学习设计随想 github
- myeclipse启动选择workspace的Launcher框
- 编程规范 --- 标识符命名
- c++第七次实验-2
- 关于java程序SQL注入的解析以及解决方法
- JAVA的HashSet源码分析
- thinkphp语言包
- Java多线程 - 第三篇
- JAVA文件下载,页面显示另存为效果
- Spring 利用FactoryBean来配置Bean
- 《编程之美》读书笔记-1.5快速找出机器故障
- 一种基于Java的异常处理装置及其异常处理方法
- Dubbo教程持续集成篇--SonarQube代码质量管理平台的配置与使用
- C++第7次作业
- Java总结篇系列:类型转换/造型
- python综合练习1-- 用户登录
- python综合练习1-- 用户登录
- Scalaz(43)- 总结 :FP就是实用的编程模式
- Scalaz(43)- 总结 :FP就是实用的编程模式
- java反射机制