编程规范 --- 可读性

2024-05-21 07:05:58

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; ”

编程规范 --- 可读性相关推荐

JavaScript编程规范-有利于效率和可读性
JavaScript编程规范类型对象数组字符串函数属性变量条件表达式和等号块注释空白逗号分号类型转换命名约定存取器构造器事件模块 jQuery ES5 兼容性性 ...
Windows客户端C/C++编程规范“建议”——前言
前言工作中接触了很多编程规范.其中最有意思的是,公司最近发布了一版C/C++编程规范,然后我看到该规范的最后一段时,有这么一句:"该规范不适用于Windows平台开发".看来这份 ...
Python编程规范及性能优化
为什么80%的码农都做不了架构师?>>> Ptyhon编程规范编码所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- .设置编辑器 ...
iOS代码编程规范根据项目经验汇总
带出几十位从零开始学iOS的实习生或试用期的开发人员后,觉得真的是千人千面,每个人写的代码都风格迥异,如果没有一个文档规范,每次都和新人进行口头的说教,大概自己是不用敲代码了,所以吃了亏了就开始编写i ...
python使用符号#表示单行注释-【经济金融及Python应用讲义】Python编程规范之注释...
原标题:[经济金融及Python应用讲义]Python编程规范之注释来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么 ...
python使用符号表示单行注释-Python编程规范之注释
来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
简明 Python 编程规范
本文最初发表于赖勇浩(恋花蝶)的博客:http://blog.csdn.net/lanphaday,如蒙转载,必须保留全文完整,未经本人同意,不得用于商业目的.51Testing软件测试网 Lfh g ...
简明 Python 编程规范v2
赖勇浩(http://laiyonghao.com) 注:之前发布一篇<简明 Python 编程规范>(见:http://blog.csdn.net/lanphaday/article/d ...
java 内部类异常_Java笔记（三内部类、异常、编程规范）
内部类(Outer.java) 在一个类中定义另外一个类,这个类就叫做内部类或内置类(inner class) 内部类和外部类分属不同的空间,都有自己的数据变量和数据方法,内部类仍然是一个独立的类内 ...

最新文章

热门文章