如何提高代码的可读性

近日有在看Brain W. Kernighan & Rob Pike 共同编著的The practice of programming(强烈推荐看看这本书)。书中提到了很多实用的细节,大多来源于作者多年的编程经验,在关于代码风格这方面就是开篇,有不少篇幅,在此整理摘录一些个人认为重要的原则(rules),虽然细小,但很重要,必要的会附上相关代码。

一、命名(Name)

1.对于全局变量最好用更具描述性的名字,对于局部变量就用短一点的名字。(Use descriptive names for globals, short name for locals)

二、表达式和语句(Expressions and Statements)
1.用必要的括号消除歧义(Parenthesize to solve ambiguity)

因为许多操作符都有各自的优先级,如果没有用好括号或是完全忘了就会让程序出现逻辑问题无法运行。

以下是示例代码:

if (x&MASK == BITS)

如果没有括号,代码会执行为

if (x & (MASK == BITS))

但实际上想操作的却是

if ((x&MASK) == BITS)

2.将复杂的表达式拆开写(Break up complex expressions)

*x += (*xp=(2*k < (n-m) ? c[k+1] : d[k--]));

上面这段代码的可读性非常差,而如果我们拆成if else语句就会好很多。

if (2*k < n-m)
*xp=c[k+1];
else
*xp =d[k--];
*x += *xp;

书中有一句话说:“我们的目标是写出清晰的代码,而不是自认为聪明的代码。”

对于 ?: 操作符的使用建议是只适用于短小的表达式,如:

max = (a > b) ? a : b ;

代码并不是越短越好,逻辑清晰和可读性十分重要,如果是以削减可读性的代价去缩短代码是不建议的。最好是想想优化算法吧:P

3.注意“副作用” (Be careful with side effects)

str[i++] = str[i++] = ' ' ;
这段代码意在将空格储存在str的后两个位置,但这取决于 i 更新数据的时间,因此可能 i 只增加了1。为了避免这种情况,我们应该将它拆开

str[i++] = ' ' ;
str[i++] = ' ' ;

而即使只有一个变量在增加也可能有类似情况
a[i++] = i ;
如果初始值是3,结果可能会是3 或者4。

三、持续性和习惯(Consistency and Idioms)
1.在花括号的使用风格上保持持续性

这里又提到了一个经常争议的问题就是“花括号到底应该直接放语句后面还是换行再写。”对此作者的建议是:

选一个你喜欢的并且保持下去,不要花时间在争吵上面。(Pick one style, use it consistently,and don't waste time arguing.):D

有一个值得一提的细节是,当你在修改别人写的代码时,你应该按照他的代码风格来写,因为这样保持风格统一方便了以后来修改代码的人。:)

2,无穷循环的选择

对于无穷的循环,作者只建议以下两种表达
for (; ;)

while( 1 )

3.谨慎使用 gets

原话是" one shoud never use gets"。
因为用gets没有办法去限制它将读到的输入长度,这种缺陷会导致安全问题,而 fgets 就会是一个更好的选择。

4.对于多种情况,用else-if语句,尽量少一些 if 嵌套

对比以下两种代码风格

if 嵌套:

if (argc==3)
if((fin = fopen(argv[1], "r"))!= NULL)
if((fout = fopen(argv[2],"W"))!= NULL){
while( 
...........
)
}else
printf(" .........."); `
else
.............
else
..............

else-if语句:

if (argc != 3)
printf(" Usage: cp inputfile outputfile\n");
else if (...........)
else if(............){
......
....
}else{
.....
}

有良好的写代码的习惯能提高写代码的可读性,提高调试的效率,也是对自己和以后修改你程序的其他程序员的一种尊重吧:D

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,961评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,444评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,009评论 0 333
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,082评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,101评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,271评论 1 278
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,738评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,395评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,539评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,434评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,481评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,160评论 3 317
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,749评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,816评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,038评论 1 256
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,548评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,140评论 2 341

推荐阅读更多精彩内容