C语言格式书写规范.doc

1、C语言书写规范指南 第 1 章文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头 文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。 C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。 1.1 版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有： （1）版权信息。 （2）文件名称，标识符，摘要。 （3）当前版本号，作者/修改者，完成日期。 （4）版本历史信息。 /* *Copyright(c)2001,吉林大学物理学院无线电 *Allr

2、ightsreserved. * *文件名称： 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】

3、为了防止头文件被重复引用，应当用 #ifndef/#define/#endif结构产生预处理 块。 【规则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=0x

4、10; 定义。 【规则1-2-7】局部变量在.c中定义 (static) unsigned in 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）定义文件开头处

5、的版权和版本声明（参见示例1-1）。 （2）对一些头文件的引用。 （3）程序的实现体（包括数据和代码）。 假设定义文件的名称为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 目录（可以是多级目录） 。

7、如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。 为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。 第 2 章程序的版式 版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风 格的重要构成因素。 可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃 勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们 学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。 2.1 空行 空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。 空行不会浪费内

8、存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍 不得用空行。 【规则2-1-1】在每个函数定义结束之后都要加空行。参见示例2-1（a） 【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。 参见示例2-1（b） /空行 void Function1() /空行 void Function2() 示例2-1(a)函数之间的空行 /空行 while (condition) statement1; /空行 if (condition) statement2; else statement3; /空行 statement4; 示例2-1(b)函

9、数内部的空行 2.2 代码行 【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅 读，并且方便于写注释。 【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多 少都要加。这样可以防止书写失误。 示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。 int width;/宽度 int height;/高度 int depth;/深度 中间使用TAB键控制距离 int width,height,depth;/宽度高度深度 x = a+b; /等号左右用空格控制距离 y = c+d; z =

10、 e+f; x = a+b; y=c+d;z=e+f; if (width Function(); 示例2-3代码行内的空格 2.4 对齐 【规则2-4-1】程序的分界符和应独占一行并且位于同一列，同时与引用它们的语句左 对齐。 【规则2-4-2】之内的代码块在右边一个TAB键处左对齐。 示例2-4（a）为风格良好的对齐，示例2-4（b）为风格不良的对齐。 void Function (int x) /programcode Void Function(intx) /programcode if (condition) /programcode else /programcode if(con

11、dition) /programcode else /programcode for (initialization; condition; update) /programcode for(initialization;condition;update) /programcode while (condition) /programcode while(condition) /programcode 如果出现嵌套的，则使用缩进对齐，如： 示例2-4(a)风格良好的对齐 示例2-4(b)风格不良的对齐 2.5 长行拆分 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过

12、长，否则眼睛看 不过来，也不便于打印。 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突 出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。 if (very_longer_variable1 = very_longer_variable12) /类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如： int minValue; int maxValue; int SetValue(); int GetValue(); 【建议3-1-1】尽量避免名字中出现数字编号，如Value1,Value2等，除非逻

13、辑上的确需 要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为 用数字编号最省事）。 3.2 简单的 Windows应用程序命名规则 作者对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用，比较适合于 Windows应用软件的开发。 【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。 例如： class Node; /类名 class LeafNode; /类名 void Draw(void); /函数名 void SetValue(int value);/函数名 【规则3-2-2】变量和参数用小写字母开头的单词组合而成。例如： BOOL flag;

14、 int drawMode; 【规则3-2-3】常量全用大写的字母，用下划线分割单词。例如： const int MAX = 100; const int MAX_LENGTH = 100; 【规则3-2-4】静态变量加前缀s_（表示static）。例 如： void Init() static int s_initValue;/静态变量 【规则3-2-5】如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。 例如： int g_howManyPeople; /全局变量 int g_howMuchMoney;/全局变量 【规则3-2-6】类的数据成员加前缀m_（表示member

15、），这样可以避免数据成员与成员函数 的参数同名。 例如： Void Object:SetValue(int width, int height) m_width = width; m_height = height; 【规则3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为 各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开 头，所有常量（或宏定义）均以GL开头。 第 4 章表达式和基本语句 表达式和语句都属于C的短语结构语法。它们看似简单，但使用时隐患比较多。本章归纳了 正确使用表达式和语句的一些规则与建议。 4.1 运算符的优先级

16、C语言的运算符有数十个，运算符的优先级与结合律如表4-1所示。注意一元运算符+ - *的优先级高于对应的二元运算符。 优先级 运算符 结合律 () - . 从左至右 ! + - （类型）sizeof + - * /复合表达式过于复杂 【规则4-2-2】不要有多用途的复合表达式。例如： d=(a=b+c)+r; 该表达式既求a值又求d值。应该拆分为两个独立的语句： a = b + c; d = a + r; 【规则4-2-3】不要把程序中的复合表达式与“真正的数学表达式”混淆。例如： if(abc) /abc是数学表达式而不是程序表达式并不表示 if (ab) returny; 改写为 if(c

17、ondition) returnx; else returny; 或者改写成更加简练的 return(condition?x:y); 4.4 循环语句的效率 C循环语句中，for语句使用频率最高，while语句其次，do语句很少用。本节重点论述循环 体的效率。提高循环体效率的基本办法是降低循环体的复杂性。 【建议4-4-1】在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环 放在最外层，以减少CPU跨切循环层的次数。例如示例4-4(b)的效率比示例4-4(a)的高。 for (row=0; row100; row+) for (col=0; col5; col+) fum = s

18、um+arowcol; 示例4-4(a)低效率：长循环在最外层 for (col=0; col5; col+) for (row=0; row100; row+) fum = sum+arowcol; 示例4-4(b)高效率：长循环在最内层 【建议4-4-2】如果循环体内存在逻辑判断，并且循环次数很大，宜将逻辑判断移到循环 体的外面。示例4-4(c)的程序比示例4-4(d)多执行了N-1次逻辑判断。并且由于前者老要进行 逻辑判断，打断了循环“流水线”作业，使得编译器不能对循环进行优化处理，降低了效率。 如果N非常大，最好采用示例4-4(d)的写法，可以提高效率。如果N非常小，两者效率差别并不

19、明显，采用示例4-4(c)的写法比较好，因为程序更加简洁。 for (i=0; iN; i+) if (condition DoSomething(); else DoOtherthing(); 表4-4(c)效率低但程序简洁 if(condition) for(i=0;iN;i+)DoSomething(); else for(i=0;iN;i+)DoOtherthing(); 表4-4(d)效率高但程序不简洁 4.5for 语句的循环控制变量 【规则4-5-1】不可在for循环体内修改循环变量，防止for循环失去控制。 【建议4-5-1】建议for语句的循环控制变量的取值采用“半开半闭区间

20、”写法。 示例4-5(a)中的x值属于半开半闭区间“0=xN”，起点到终点的间隔为N，循环次数为N。 示例4-5(b)中的x值属于闭区间“0=x=N-1”，起点到终点的间隔为N-1，循环次数为N。 相比之下，示例4-5(a)的写法更加直观，尽管两者的功能是相同的。 for(intx=0;xN;x+) 示例4-5(a)循环变量属于半开半闭区间 for(intx=0;x0) *pbTo+=*pbFrom+; returnpvTo; 示例6-5复制不重叠的内存块 assert不是一个仓促拼凑起来的宏。为了不在程序的Debug版本和Release版本引起差别， assert不应该产生任何副作用。所以a

21、ssert不是函数，而是宏。程序员可以把assert看成一 个在任何系统状态下都可以安全使用的无害测试手段。如果程序在assert处终止了，并不是 说含有该assert的函数有错误，而是调用者出了差错，assert可以帮助我们找到发生错误的 原因。 很少有比跟踪到程序的断言，却不知道该断言的作用更让人沮丧的事了。你化了很多时间，不 是为了排除错误，而只是为了弄清楚这个错误到底是什么。有的时候，程序员偶尔还会设计出 有错误的断言。所以如果搞不清楚断言检查的是什么，就很难判断错误是出现在程序中，还是 出现在断言中。幸运的是这个问题很好解决，只要加上清晰的注释即可。这本是显而易见的事 情，可是很少有

22、程序员这样做。这好比一个人在森林里，看到树上钉着一块“危险”的大牌子。 但危险到底是什么？树要倒？有废井？有野兽？除非告诉人们“危险”是什么，否则这个警告 牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略，甚至被删除。 【规则6-5-1】使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况 之间的区别，后者是必然存在的并且是一定要作出处理的。 【规则6-5-2】在函数的入口处，使用断言检查参数的有效性（合法性）。 【建议6-5-1】在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一 旦确定了的假定，就要使用断言对假定进行检查。 【建议6-5-2】一般教科书都鼓励

23、程序员们进行防错设计，但要记住这种编程风格可能 会隐瞒错误。当进行防错设计时，如果“不可能发生”的事情的确发生了，则要使用断 言进行报警。 6.6 引用与指针的比较 引用是C+中的概念，初学者容易把引用和指针混淆一起。一下程序中，n是m的一个引用 （reference），m是被引用物（referent）。 int m; int n相当于m的别名（绰号），对n的任何操作就是对m的操作。例如有人名叫王小毛，他的 绰号是“三毛”。说“三毛”怎么怎么的，其实就是对王小毛说三道四。所以n既不是m的拷 贝，也不是指向m的指针，其实n就是m它自己。 引用的一些规则如下： （1）引用被创建的同时必须被初始化（

24、指针则可以在任何时候被初始化）。 （2）不能有NULL引用，引用必须与合法的存储单元关联（指针则可以是NULL）。 （3）一旦引用被初始化，就不能改变引用的关系（指针则可以随时改变所指的对象）。以下示 例程序中，k被初始化为i的引用。语句k=j并不能将k修改成为j的引用， 只是把k的值改变成为6。由于k是i的引用，所以i的值也变成了6。 int i=5; int j=6; int k=j; /k和i的值都变成了6; 上面的程序看起来象在玩文字游戏，没有体现出引用的价值。引用的主要功能是传递函 数的参数和返回值。C+语言中，函数的参数和返回值的传递方式有三种：值传递、指针传递 和引用传递。 以下

25、是“值传递”的示例程序。由于Func1函数体内的x是外部变量n的一份拷贝，改变x的 值不会影响n,所以n的值仍然是0。 void Func1(int x) x=x+10; intn=0; Func1(n); cout“n=”nendl; /n=0 以下是“指针传递”的示例程序。由于Func2函数体内的x是指向外部变量n的指针，改变 该指针的内容将导致n的值改变，所以n的值成为10。 void Func2(int *x) (*x)=(*x)+10; int n=0; Func2( cout“n=”nendl; /n=10 以下是“引用传递”的示例程序。由于Func3函数体内的x是外部变量n的引用

26、，x 和n是同一个东西，改变x等于改变n，所以n的值成为10。 void Func3(int int n=0; Func3(n); cout“n=”nendl; /n=10 对比上述三个示例程序，会发现“引用传递”的性质象“指针传递”，而书写方式象 “值传递”。实际上“引用”可以做的任何事情“指针”也都能够做，为什么还要“引用”这 东西？ 答案是“用适当的工具做恰如其分的工作”。 指针能够毫无约束地操作内存中的如何东西，尽管指针功能强大，但是非常危险。就象一 把刀，它可以用来砍树、裁纸、修指甲、理发等等，谁敢这样用？ 如果的确只需要借用一下某个对象的“别名”，那么就用“引用”，而不要用“指针”， 以免发生意外。比如说，某人需要一份证明，本来在文件上盖上公章的印子就行了，如果把 取公章的钥匙交给他，那么他就获得了不该有的权利。