怎样编写高质量的C代码

一、我们写的代码是给别人看的，所以在代码开头我们必须声明这个程序是用来干嘛的，作者是谁，以及版本号和修改历史，以及修改者的名称，还有完成的日期能让别人一目了然。这是我的一个例子：

二、头文件的使用：

1.首先说一下头文件的作用：调用库功能以及加强类型安全检查。

2.为防止头文件被重复引用，应该使用 ifndef/define/endif结构产生预处理块。

3.#include <stdio.h> 格式引用标准库的头文件，即编译器从标准库目录开始搜索。#include "stdio.h"格式引用非标准库的头文件，即编译器从用户工作目录开始搜索。

4.在头文件中最好不用全局变量，不要出现extern int value这类声明。

5.头文件放在一份目录下，定义文件放在另一个目录下，最好这样分开。

三、具体程序：

1.空行

程序好的布局需要空行，每个函数定义结束之后加空行，在函数体内，逻辑密切相关语句不用空行，其他地方用空行分离。

[cpp] view plain copy

void fun()   

{  

...;   

}   

//空行   

void fun1()   

{   

while (1);   

{   

...;   

//空行   

if (...)   

{   

...;   

}   

}   

}  

//空行  

2.代码行

一行代码只做一件事情，定义变量或者是一条语句，在定义变量的同时最好将其初始化；

if、for、while、do等语句占一行，不论执行语句多长，都记得加‘{’、‘}’。

[cpp] view plain copy

int a=1;  

int b=2;  

int c=a+b;  

if (..)  

{  

....;  

}  

//空行  

other();  


3.代码行内的空格

关键字之后留空格，if、for等关键字之后留空格再跟括号；

向前紧跟的“，”、“（”、“）”、“；”不留空格；

”，“后留空格，”；“如果不是一行的结束符，其后留空格；

操作符等二元操作符前后加空格，一元操作符前后不加空格；“[ ]”、“.”、“->”前后不加空格，

对较长表达式可适当去掉一些空格。

[cpp] view plain copy

void fun(int a ,int b, int c);  

[cpp] view plain copy

if (year >= 2000)  

[cpp] view plain copy

if ((a>=b) && (c<=d))  

[cpp] view plain copy

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

[cpp] view plain copy

array[2] = 0;  

[cpp] view plain copy

int *x = &y;  

4.对齐

“{”、“}”独占一行并且在同一列对齐，与引用它们的语句左对齐，括号里面的代码块左对齐。嵌套括号缩进对齐。

[cpp] view plain copy

void fun(int x)  

{  

.....;  

}  

for (...)  

{  

....;  

}  

[cpp] view plain copy

[cpp] view plain copy

{  

[cpp] view plain copy

{  

[cpp] view plain copy

...;  

[cpp] view plain copy

}  

[cpp] view plain copy

[cpp] view plain copy

}  

5.长行拆分

代码行最大长度控制在70至80个字符以内，便于查看和打印，长表达式在低优先级操作符处拆分成新行，操作符放在新行之首，并适当缩进

[cpp] view plain copy

if ((a1 >= a2)  

&& (a3 >= a4)  

&& (a5 >= a6))  

int main(a1,  

a2);  

for (long;  

middle;  

short)  


6.修饰符的位置

* 和 & 紧靠变量名

7.注释，注释符有/*... */、//、#if 0,#endif

注释要少而精，不能喧宾夺主，它的作用是帮助理解代码；

边写代码边注释，保证一致性，避免二义性以及在注释中使用不常用缩写；

代码较长时，或者有多重嵌套时，应当在段落的结束处加注释，便于阅读。