1、C语言书写规范指南第 1 章文件结构每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。1.1 版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/修改者，完成日期。（4）版本历史信息。/*Copyright(c)2001,吉林大学物理学院无线电*Allrightsreserved.
2、*文件名称： filename.h*文件标识： *摘 要： 简要描述本文件的内容*当前版本： 1.1*作 者： 输入作者（或修改者）名字*完成日期： 2007年 7月 20日*取代版本： 1.0*原作者 ： 输入原作者（或修改者）名字*完成日期： 2007年 5月 10日*/示例1-1版权和版本的声明1.2 头文件的结构头文件由三部分内容组成：（1）头文件开头处的版权和版本声明（参见示例1-1）。（2）预处理块。（3）函数和类结构声明等。假设头文件名称为 SCL_SPI.h，头文件的结构参见示例1-2。【规则1-2-1】为了防止头文件被重复引用，应当用 #ifndef/#define/#end
3、if结构产生预处理块。【规则1-2-2】用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。【规则1-2-3】用 #include “filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。【规则1-2-4】 #include 后面使用TAB键控制排版 。【规则1-2-5】头文件中只存放“声明”而不存放“定义”【规则1-2-6】全局变量在头文件中声明,在.c文件中定义 .h extern in tvalue; 声明。.c in tvalue=0x10; 定义。【规则1-2-7】局部变量在.c中定义 (static) unsigned i
4、n tvalue; 定义。/版权和版本声明见示例1-1，此处省略。#ifndef SCL_SPI_H /防止SCL_SPI.h被重复引用#define SCL_SPI_H#include /引用标准库的头文件#include “SCL_CAN.h” /引用非标准库的头文件void Function1();/全局函数声明extern unsign int value;/全局变量声明#endif示例1-2C头文件的结构1.3 定义文件的结构定义文件有三部分内容：（1）定义文件开头处的版权和版本声明（参见示例1-1）。（2）对一些头文件的引用。（3）程序的实现体（包括数据和代码）。假设定义文件的名称
5、为SCL_SPI.c，定义文件的结构参见示例1-3。/版权和版本声明见示例1-1，此处省略。#include“SCL_SPI.h” /引用头文件/全局变量定义unsign int value = 0x10;/全局函数的实现体void Function1()示例1-3C定义文件的结构1.4 头文件的作用早期的编程语言如Basic、Fortran没有头文件的概念，C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而
6、不必关心接口怎么实现的。编译器会从库中提取相应的代码。（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5 目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于 include 目录，将定义文件保存于 source 目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第 2 章程序的版式版
7、式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。2.1 空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。【规则2-1-1】在每个函数定义结束之后都要加空行。参见示例2-1（a）【规则2-1-2】在一个函数体内，逻
8、揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b）/空行void Function1()/空行void Function2()示例2-1(a)函数之间的空行/空行while (condition)statement1;/空行if (condition)statement2;elsestatement3;/空行statement4;示例2-1(b)函数内部的空行2.2 代码行【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不
9、论执行语句有多少都要加。这样可以防止书写失误。示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。int width;/宽度int height;/高度int depth;/深度中间使用TAB键控制距离int width,height,depth;/宽度高度深度x = a+b; /等号左右用空格控制距离y = c+d;z = e+f;x = a+b; y=c+d;z=e+f;if (width =”、“”这类操作符前后不加空格。 【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for(i=0;i= 2000) /良好的风格if
10、(year=2000) /不良的风格if (a=b) /不要写成b - Function();示例2-3代码行内的空格2.4 对齐【规则2-4-1】程序的分界符和应独占一行并且位于同一列，同时与引用它们的语句左对齐。【规则2-4-2】之内的代码块在右边一个TAB键处左对齐。示例2-4（a）为风格良好的对齐，示例2-4（b）为风格不良的对齐。void Function (int x)/programcodeVoid Function(intx)/programcodeif (condition)/programcodeelse/programcodeif(condition)/programco
11、deelse/programcodefor (initialization; condition; update)/programcodefor(initialization;condition;update)/programcodewhile (condition)/programcodewhile(condition)/programcode如果出现嵌套的，则使用缩进对齐，如：示例2-4(a)风格良好的对齐 示例2-4(b)风格不良的对齐2.5 长行拆分 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。if (very_longer_variable1 = very_longer_variable12)/类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如：int minValue;int maxValue;
