xrotor.github.io

C 语言代码规范(编程规范)

代码规范化的七大原则

代码规范化基本上有七大原则,体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上。

1) 空行

空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序会多消耗一些纸张,但是值得。

2) 空格

注意,运算符 % 是求余运算符,与 printf 中 %d 的 % 不同,所以 %d 中的 % 前后不用加空格。

注意:

总之,规则六中的是单目运算符,而规则五中的是双目运算符,它们是不一样的。

for (i=0; i<10; i++)

for 和分号后面保留空格就可以了,= 和 < 前后的空格可去掉。

3) 成对书写

成对的符号一定要成对书写,如 ()、{}。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。

4) 缩进

缩进是通过键盘上的 Tab 键实现的,缩进可以使程序更有层次感。原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进。

5) 对齐

对齐主要是针对大括号 {} 说的:

还有需要注意的是,很多编程软件是会”自动对齐”的,比如:

#include <stdio.h>
int main(void)
{
    if (…)
    return 0;
}

写完 if 那一行后,按回车,此时光标在括号的右边,而此 if 下的大括号要写在与 if 左对齐的正下方,通常我们是按一下 Backspace 键使光标停在与 if 左对齐的正下方。但事实上我们不需要这样做,我们直接输入大括号即可,系统会自动对齐到与 if 左对齐的正下方。再接着看:

#include <stdio.h>
int main(void)
{
    if (…)
    {
        while (…)
        }
    return 0;
}

写完 while 那一行后,按回车,此时光标不是停在与 while 左对齐的正下方,同样,我们不需要按 Backspace,直接输入大括号即可,系统会自动对齐到与 while 左对齐的正下方的。

此外编程软件还有”对齐、缩进修正”功能。就是按 Ctrl+A 全选,然后按 Alt+F8,这时程序中所有成对的大括号都会自动对齐,未缩进的也会自动缩进。不管是在编程过程中,还是在编写结束完之后,都可以使用这个技巧。但如果完全按照规范写,那根本就不需要这个技巧,所以,这只是一个辅助功能。

6) 代码行

7) 注释

C 语言中一行注释一般采用 //…,多行注释必须采用 /*…*/。注释通常用于重要的代码行或段落提示。在一般情况下,源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码,但注意不可过多地使用注释。

i++;  // i 加 1

这个就是多余的注释。

实际案例

下面我们给出一段求一元二次方程的代码,让大家实际感受一下。虽然这个程序不包含所有的规范,但一些包含的规范我们可以对照着看看。

以下程序的功能是把任何一个一元二次方程 ax²+bx+c=0 的解给求出来。

#include <stdio.h>
#include <math.h>  /* 因为要用到求平方函数 sqrt(),所以要包含头文件 math.h */

int main(void)
{
    // 把三个系数保存到计算机中
    int a = 1;  // "=" 不表示相等,而是表示赋值
    int b = 2;
    int c = 1;
    double delta;   // delta 存放的是 b*b - 4*a*c 的值
    double x1, x2;  // 分别用于存放一元二次方程的两个解

    delta = b*b - 4*a*c;
    if (delta > 0)
    {
        x1 = (-b + sqrt(delta)) / (2*a);
        x2 = (-b - sqrt(delta)) / (2*a);
        printf("该一元二次方程有两个解,x1 = %f, x2 = %f\n", x1, x2);
    }
    else if (0 == delta)
    {
        x1 = (-b) / (2*a);
        x2 = x1;  // 左边值赋给右边
        printf("该一元二次方程有一个唯一解,x1 = x2 = %f\n", x1);
    }
    else
    {
        printf("无解\n");
    }
    return 0;
}

运行结果:

该一元二次方程有一个唯一解,x1 = x2 = -1.000000

大家不用关心程序的逻辑和思路,只关注代码规范即可。