C语言格式书写规范.docx

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

2、erved、*文件名称:*文件标识: *摘 要:简要描述本文件的内容*当前版本: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/#endif结构产生预处理块。【规则1-2

3、-2】用 #include 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。【规则1-2-3】用 #include “”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。【规则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 in tvalue; 定义。/版权与版本声明见示例1-1

4、,此处省略。 #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)程序的实现体(包括数据与代码)。假设定义文件的名称为SCL_SPI、c,定义文件的结构参见示例1-3。/

5、版权与版本声明见示例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 height)/左右用空格控制距离 dosomething();/使用TAB键控制距离if(width=”、“=”、“+”、“*”、“%”、“&”、“|”、“”这类操作符前后不加空格。 【建议2-3-1】对于表达式比较长的for

10、语句与if语句,为了紧凑起见可以适当地去掉一些空格,如for(i=0;i10;i+)与if(a=b)&(c= 2000) /良好的风格if(year=2000) /不良的风格if (a=b) & (c=b&c=d) /不良的风格for (i=0; i10; i+) /良好的风格for(i=0;i10;i+) /不良的风格for(I = 0; I 10; I+) /过多的空格x = a b ? a : b; /良好的风格x=aFunction(); /不要写成b - Function();示例2-3代码行内的空格2、4对齐【规则2-4-1】程序的分界符与应独占一行并且位于同一列,同时与引用它们的

11、语句左对齐。【规则2-4-2】之内的代码块在右边一个TAB键处左对齐。示例2-4(a)为风格良好的对齐,示例2-4(b)为风格不良的对齐。 void Function (int x) /programcodeVoid Function(intx)/programcodeif (condition) /programcodeelse /programcodeif(condition)/programcodeelse/programcodefor (initialization; condition; update) /programcodefor(initialization;condition

12、;update)/programcodewhile (condition) /programcodewhile(condition)/programcode如果出现嵌套的,则使用缩进对齐,如: 示例2-4(a)风格良好的对齐 示例2-4(b)风格不良的对齐2、5长行拆分z 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛瞧不过来,也不便于打印。z 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。if (very_longer_variable1 = very

13、_longer_variable12)&(very_longer_variable3 = very_longer_variable14) 使用TAB键控制距离&(very_longer_variable5 Draw(); /类的成员函数z 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如:int minValue;int maxValue;int SetValue();int GetValue(); 【建议3-1-1】尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这就是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名

14、字(因为用数字编号最省事)。3、2简单的Windows应用程序命名规则作者对“匈牙利”命名规则做了合理的简化,下述的命名规则简单易用,比较适合于Windows应用软件的开发。z 【规则3-2-1】类名与函数名用大写字母开头的单词组合而成。例如:class Node; /类名class LeafNode; /类名void Draw(void); /函数名void SetValue(int value);/函数名z 【规则3-2-2】变量与参数用小写字母开头的单词组合而成。例如:BOOL flag;int drawMode;z 【规则3-2-3】常量全用大写的字母,用下划线分割单词。例如:cons

15、t int MAX = 100;const int MAX_LENGTH = 100;z 【规则3-2-4】静态变量加前缀s_(表示static)。例如:void Init()static int s_initValue;/静态变量z 【规则3-2-5】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。例如:int g_howManyPeople; /全局变量int g_howMuchMoney; /全局变量z 【规则3-2-6】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。例如:Void Object:SetValue(int wid

16、th, int height)m_width = width;m_height = height; z 【规则3-2-7】为了防止某一软件库中的一些标识符与其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。 第4章表达式与基本语句表达式与语句都属于C的短语结构语法。它们瞧似简单,但使用时隐患比较多。本章归纳了正确使用表达式与语句的一些规则与建议。4、1运算符的优先级C语言的运算符有数十个,运算符的优先级与结合律如表4-1所示。注意一元运算符+ - *的优先级高于对应的二元运算符。优先级运算符结合

17、律从高到低排列() - 、从左至右! + - (类型)sizeof+ - * &从右至左* / %从左至右+ -从左至右从左至右 =从左至右= !=从左至右&从左至右从左至右|从左至右&从左至右|从右至左?:从右至左= += -= *= /= %= &= =|= =从左至右表4-1运算符的优先级与结合律 【规则4-1-1】如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免使用默认的优先级。由于将表4-1熟记就是比较困难的,为了防止产生歧义并提高可读性,应当用括号确定表达式的操作顺序。例如:word = (high=b&cd&c+f=g+h;/复合表达式过于复杂【规则4-2-2】不要有多用途的复合表达式。例如:d=(a=b+c)+r;该表达式既求a值又求d值。应该拆分为两个独立的语句:a = b