如何提高代码的可读性

作者: 綿綿_ | 来源:发表于2016-12-03 22:30 被阅读0次

    近日有在看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

    相关文章

      网友评论

        本文标题:如何提高代码的可读性

        本文链接:https://www.haomeiwen.com/subject/wtwcmttx.html