即日起在codingBlog上分享您的技术经验即可获得积分,积分可兑换现金哦。

C语言代码书写风格

编程语言 u010590568 64℃ 0评论

相信经常coding的同学在项目中看别人的代码一定会像我一样的头痛,特别是有点强迫症的程序猿在看和自己风格差距较大的代码的时候内心甚至会出现烦躁和想去“改正”的念头。下面就为大家总结下一些常见的代码编程风格。

一、复合语句的对齐和缩进风格


(1). K&R风格,Kernighan和Ritchie共同完成C语言”白皮书”C Programing Language一书的时候使用的风格。由于此书被当时的C程序员誉为C语言圣经,所以此风格也被争相模仿。左边的花括号出现在行的末尾。通过缩进保持代码的紧凑,缺点是不容易找到左边的花括号:

if (line_num == MAX_LINES) {
    line_num = 0;
    page_num++;
}

(2).Allman风格,Eric Allman(sendmail和其他一些UNIX工具的作者)的姓氏命名的,每个花括号单独占一行。容易检查括号的匹配:

if (line_num == MAX_LINES)
{
    line_num = 0;
    page_num++;
}

(3). Whitesmiths风格,它是因为Whitesmith C编译器而普及起来的,规定花括号采用缩进形式。C++的同学在看STL代码的时候是否有似曾相识的感觉呢?

if (line_num == MAX_LINES)
    {
    line_num = 0;
    page_num++;
    }

(4). GUN风格,它用于GUN项目所开发的软件中,它对花括号采用缩进,然后再进一步缩进内层语句。喜欢Linux系统的同学在看一些工具的源码的时候应该会注意到:

if (line_num == MAX_LINES)
    {
        line_num = 0;
        page_num++;
    }

这四种不同的编码风格中,在国内使用最多的毫无疑问是K&R和Allman,以前C语言大行其道的时候很多事第一种,当更多的Java、C#、和C++语言流行的现在反而是第二种Allman风格的更多一些,当然Java里也有很多是K&R风格。如果是Windows平台由于VS的关系默认第二种缩进的关系还是Allman风格更多。

二、变量命名的风格和习惯


一般C语言的程序员在命名宏定义用全大写表示,多个单词使用下划线’_’来连接。


而变量的命名反而大致分成二种风格:


(1)驼峰命名法


多个单词连接成一个变量名的时候后面的单词每个单词的第一个字母大写的方式区分,比如:

lineNum

(2)下划线命名法


在多个单词的中间使用下划线来区分,比如:

line_num

驼峰命名法由于Java、C#和C++等一些语言的出现而流行一时,下划线命名法是早期C语言经常使用的方法,目前还有很多老的C语言程序猿喜欢下划线,可能觉得看起来更优美吧,至于帕斯卡等等一些命名方法就不提及了。

三、注释的风格


C语言在C89的时候只有/**/这一种注释可用,在C99的时候从C++等一些语言借鉴过来了//的注释方式。


这两种注释其实各有优缺点。


(1). /**/注释


在注释很多代码的时候异常方便,甚至还能注释出很多花样,比如翼型注释

/*此方法为翼型注释*/

/*******************************
 *  盒型注释                    *   
 ******************************/

 /*
  *  盒型注释的简化版
  */

(2). //注释


在注释单行的时候特别方便,而且配合/* /注释进行嵌套注释也弥补了 /*/注释不能嵌套的缺点,而最主要的问题是//注释只会影响到单行,不会因为注释不当而引起很多行被注释掉的问题,当然在现在强大的IDE面前,很大注释都有方便的快捷键,一些注释的不方便也就荡然无存了。

四. C语言的函数无参数时是为void还是()?


经常看到一些C语言的代码,在函数没有参数的时候往往都是空着,写成(),但是这种写法对C语言来说其实是可以接受任何参数!你可能会很奇怪为什么这样设计,这也与开始设计C语言的初衷有关,在别的语言中完全不符合规范的东西在C中都是允许的。因为C是一个允许计算结果由实现定义的语言。也就是在特定的平台上编译、链接和执行允许具有不同的结果!如果大的自由度带来的可能就是更多的陷阱和错误的可能。


所以我个人觉得避开这些陷阱的最好方法是保持一个良性的C程序编码习惯和风格,比如在确定不需要参数的时候使用void代替()这种什么也不写,没有参数就确定的告诉编译器我不需要参数,千万不要和编译器玩暧昧!


当然这种情况在C++中已经不再存在,C++不管你写不写都是void!

五、switch这种复合语句改如何对齐?else如果嵌套?


(1) if else嵌套这个问题,说简单点,在需要的时候都添加上去吧。当然我个人有时候在只有一行的时候为了保持简洁的代码往往不添加花括号,那么在别人添加代码的时候就需要保持谨慎了!

if (i > 0 && i < 10)
    if (i > 5)
        printf("YES");
else
    printf("i greater than 10!\n");

为了让代码看起来简洁明快我们可能会写出这种代码,好吧,你可能会和我一样是一个由轻微强迫症的coder,代码风格就要”最好”的。哪怕一个个改也要和自己的风格一样,但是上述代码当i=2的时候是否会输出最后的i greater than 10?,答案是不会,C语言的else有个规则是子句应该属于离它最近的if。所以上述代码实际的缩进是:

if (i > 0 && i < 10)
    if (i > 5)
        printf("YES");
    else
        printf("i greater than 10!\n");

导致意义完全不同了!


(2)swith的代码对齐风格


分支标号后面放置语句:

switch (value) {
case 1printf("branch 1!");
        break;
case 2 : printf("branch 2!");
        break;
default:
}

如果每个分支只有一个简单的操作,break语句甚至可以和操作放在一行

switch (value) {
case 1printf("branch 1!"); break;
case 2 : printf("branch 2!"); break;
default:
}

另外一种是把语句放在分支标号的下面,并且对语句进行缩进,从而凸显出分支标号:

switch (value) {
case 1printf("branch 1!");
    break;
case 2 :
    printf("branch 2!");
    break;
default:
}

当每个分支语句都较为短小的时候采用第一种方式明显是个更好的选择,第二种方式更适合每个分支都很庞大的分支语句,当然这个时候可别忘了添加上花括号,否则编译器可是会提示你的!

总结:在实际项目中,如果你是项目技术的决策者则可以根据你自己的喜好和规范制定规则,并且让下面的人严格执行这套风格(想笑^^),如果不是还是老老实实的用项目的这套吧,千万别画蛇添足!当然如果私下写自己的代码则用自己喜欢的就行,有些风格的区别其实很难说好坏,始终如一的坚持一种风格就可以了!

参考:C语言程序设计

转载请注明:CodingBlog » C语言代码书写风格

喜欢 (0)or分享 (0)
发表我的评论
取消评论

*

表情