软件编写规范(可读性)

//摘抄自华为软件编写规范
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;  
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

COSummer

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值