《C语言格式书写规范.pdf》由会员分享，可在线阅读，更多相关《C语言格式书写规范.pdf（26页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、C语言书写标准指南第第 1 1 章文件结构章文件结构每个C程序通常分为两个文件。一个文件用于保存程序的声明 declaration，称为头文件。另一个文件用于保存程序的实现implementation，称为定义 definition文件。C程序的头文件以“.h为后缀，C程序的定义文件以“.c为后缀。1.11.1 版权和版本的声明版权和版本的声明版权和版本的声明位于头文件和定义文件的开头参见例如1-1，主要内容有：1版权信息。2文件名称，标识符，摘要。3当前版本号，作者/修改者，完成日期。4版本历史信息。/*Copyright(c)2001,吉林大学物理学院无线电*Allrightsreserv
2、ed.*文件名称：filename.h*文件标识：*摘要：简要描述本文件的内容*当前版本：1.1*作者：输入作者或修改者名字*完成日期：2007年7月20日*取代版本：1.0*原作者：输入原作者或修改者名字*完成日期：2007年5月10日*/例如1-1版权和版本的声明1.21.2 头文件的结构头文件的结构头文件由三局部内容组成：1头文件开头处的版权和版本声明参见例如1-1。2预处理块。3函数和类结构声明等。假设头文件名称为 SCL_SPI.h，头文件的结构参见例如1-2。【规那么1-2-11-2-1】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。
3、【规那么1-2-21-2-2】用#include 格式来引用标准库的头文件编译器将从标准库目录开始搜索。【规那么1-2-31-2-3】用#include“filename.h格式来引用非标准库的头文件编译器将从用户的工作目录开始搜索。【规那么1-2-41-2-4】#include 后面使用TAB键控制排版。【规那么1-2-51-2-5】头文件中只存放“声明而不存放“定义【规那么1-2-61-2-6】全局变量在头文件中声明,在.c文件中定义.h extern in tvalue;声明。.c in tvalue=0 x10;定义。【规那么1-2-71-2-7】局部变量在.c中定义(static)u
4、nsigned in tvalue;定义。/版权和版本声明见例如1-1，此处省略。#ifndef#define#includeSCL_SPI_H /防止SCL_SPI.h被重复引用SCL_SPI_H /引用标准库的头文件“SCL_CAN.h/引用非标准库的头文件#includevoid Function1();/全局函数声明extern unsign int value;/全局变量声明#endif例如1-2C头文件的结构1.31.3 定义文件的结构定义文件的结构定义文件有三局部内容：1定义文件开头处的版权和版本声明参见例如1-1。2对一些头文件的引用。3程序的实现体包括数据和代码。假设定义文件
5、的名称为SCL_SPI.c，定义文件的结构参见例如1-3。/版权和版本声明见例如1-1，此处省略。#include“SCL_SPI.h/引用头文件/全局变量定义unsign int value=0 x10;/全局函数的实现体void Function1()例如1-3C定义文件的结构1.41.4 头文件的作用头文件的作用早期的编程语言如Basic、Fortran没有头文件的概念，C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：1通过头文件来调用库功能。在很多场合，源代码不便或不准向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用
6、库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。2头文件能加强类型平安检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规那么能大大减轻程序员调试、改错的负担。1.51.5 目录结构目录结构如果一个软件的头文件数目比拟多如超过十个，通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于 include 目录，将定义文件保存于 source 目录可以是多级目录。如果某些头文件是私有的，它不会被用户的程序直接引用，那么没有必要公开其“声明。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第第 2
7、 2 章程序的版式章程序的版式版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为“书法。好的“书法可让人对程序一目了然，看得兴致勃勃。差的程序“书法如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法，弥补大学计算机教育的漏洞，实在很有必要。2.12.1 空行空行空行起着分隔程序段落的作用。空行得体不过多也不过少将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。【规那么2-1-12-1-1】在每个函数定义结束之后都要加空行。参见例如2-1
8、a【规那么2-1-22-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见例如2-1b/空行void Function1()/空行void Function2()例如2-1(a)函数之间的空行/空行while(condition)statement1;/空行if(condition)statement2;elsestatement3;/空行statement4;例如2-1(b)函数内部的空行2.22.2 代码行代码行【规那么2-2-12-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。【规那么2-2-22-
9、2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不管执行语句有多少都要加。这样可以防止书写失误。例如2-2a为风格良好的代码行，例如2-2b为风格不良的代码行。intwidth;/宽度intheight;/高度intdepth;/深度中间使用TAB键控制距离x=a+b;/等号左右用空格控制距离intwidth,height,depth;/宽度高度深度x=a+b;y=c+d;z=e+f;y=c+d;z=e+f;if(widthheight)dosomething();if(width height)/=、“=、“+、“*、“%、“&、“|、“这类操作符前后不加空格。【
10、建议2-3-12-3-1】对于表达式比拟长的for语句和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();/良好的风格/不良的风格/良好的风格/不良的风格/良好的风格/不良的风格/良好的风格/不良的风格/过多的空格/良好的风格/不好的风格/良好的风格/不良的风格/不要写成array 5 =0;/不要写成a.Function();/不要写
11、成b-Function();例如2-3代码行内的空格2.42.4 对齐对齐【规那么2-4-12-4-1】程序的分界符和应独占一行并且位于同一列，同时与引用它们的语句左对齐。【规那么2-4-22-4-2】之内的代码块在右边一个TAB键处左对齐。例如2-4a为风格良好的对齐，例如2-4b为风格不良的对齐。void Function(int x)/programcodeif(condition)/programcodeelse/programcodeVoid Function(intx)/programcodeif(condition)/programcodeelse/programcodefor(
12、initialization;condition;update)for(initialization;condition;update)/programcode/programcodewhile(condition)while(condition)/programcode如果出现嵌套的，那么使用缩进对齐，如：/programcode例如2-4(a)风格良好的对齐例如2-4(b)风格不良的对齐2.5 长行拆分长行拆分【规那么2-5-12-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否那么眼睛看不过来，也不便于打印。【规那么2-5-22-5-2】长表达式要在低优先级操作符处
13、拆分成新行，操作符放在新行之首以便突出操作符。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。if(very_longer_variable1=very_longer_variable12)&(very_longer_variable3=very_longer_variable14)使用TAB键控制距离&(very_longer_variable5 Draw();/类的成员函数【规那么3-1-83-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如：intminValue;maxValue;intintSetValue();GetValue();int【建议3-1-13
14、-1-1】尽量防止名字中出现数字编号，如 Value1,Value2等，除非逻辑上确实需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字因为用数字编号最省事。3.2 简单的简单的 Windows应用程序命名规那么应用程序命名规那么作者对“匈牙利命名规那么做了合理的简化，下述的命名规那么简单易用，比拟适合于Windows应用软件的开发。【规那么3-2-13-2-1】类名和函数名用大写字母开头的单词组合而成。例如：classNode;/类名classLeafNode;/类名voidDraw(void);/函数名voidSetValue(int value);/函数名【规那么3
15、-2-23-2-2】变量和参数用小写字母开头的单词组合而成。例如：BOOLflag;drawMode;int【规那么3-2-33-2-3】常量全用大写的字母，用下划线分割单词。例如：const intMAX=100;const intMAX_LENGTH=100;【规那么3-2-43-2-4】静态变量加前缀s_表示static。例如：void Init()static ints_initValue;/静态变量【规那么3-2-53-2-5】如果不得已需要全局变量，那么使全局变量加前缀g_表示global。例如：intg_howManyPeople;/全局变量intg_howMuchMoney;/
16、全局变量【规那么3-2-63-2-6】类的数据成员加前缀m_表示member，这样可以防止数据成员与成员函数的参数同名。例如：Void Object:SetValue(int width,int height)m_width=width;m_height=height;【规那么3-2-73-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量或宏定义均以GL开头。第第 4 4 章表达式和根本语句章表达式和根本语句表达式和语句都属于C的短语结构语法。它们看似简单，但使用时隐患比拟多。
17、本章归纳了正确使用表达式和语句的一些规那么与建议。4.1 运算符的优先级运算符的优先级C语言的运算符有数十个，运算符的优先级与结合律如表4-1所示。注意一元运算符+*的优先级高于对应的二元运算符。-优先级运算符结合律从左至右从右至左从左至右从左至右从左至右从左至右从左至右从左至右从左至右从左至右从左至右从右至左从右至左从左至右从高()-.!+-类型sizeof+-*&*/%+-&|&|?:=+=-=*=/=%=到低排列=!=&=|=表4-1运算符的优先级与结合律【规那么4-1-14-1-1】如果代码行中的运算符比拟多，用括号确定表达式的操作顺序，防止使用默认的优先级。由于将表4-1熟记是比拟困
18、难的，为了防止产生歧义并提高可读性，应当用括号确定表达式的操作顺序。例如：word=(high=b&cd&c+f=g+h;/复合表达式过于复杂【规那么4-2-24-2-2】不要有多用途的复合表达式。例如：d=(a=b+c)+r;该表达式既求a值又求d值。应该拆分为两个独立的语句：a=b+c;d=a+r;【规那么4-2-34-2-3】不要把程序中的复合表达式与“真正的数学表达式混淆。例如：if(abc)/abc是数学表达式而不是程序表达式并不表示if(ab)&(bc)而是成了令人费解的if(ab)=或“=-EPSINON)&(x=EPSINON)其中EPSINON是允许的误差即精度。4.3.44
19、.3.4 指针变量与零值比拟指针变量与零值比拟【规那么4-3-44-3-4】应当将指针变量用“=或“！=与NULL比拟。指针变量的零值是“空记为NULL。尽管NULL的值与0相同，但是两者意义不同。假设指针变量的名字为p，它与零值比拟的标准if语句如下：if(p=NULL)/p与NULL显式比拟，强调p是指针变量if(p!=NULL)不要写成if(p=0)/容易让人误解p是整型变量if(p!=0)或者if(p)/容易让人误解p是布尔变量if(!p)4.3.54.3.5 对对 if if 语句的补充说明语句的补充说明有时候我们可能会看到if(NULL=p)这样乖僻的格式。不是程序写错了，是程序员
20、为了防止将if(p=NULL)误写成if(p=NULL)，而有意把p和NULL颠倒。编译器认为if(p=NULL)是合法的，但是会指出if(NULL=p)是错误的，因为NULL不能被赋值。程序中有时会遇到if/else/return的组合，应该将如下不良风格的程序if(condition)returnx;returny;改写为if(condition)returnx;elsereturny;或者改写成更加简练的return(condition?x:y);4.44.4 循环语句的效率循环语句的效率C循环语句中，for语句使用频率最高，while语句其次，do语句很少用。本节重点论述循环体的效率。
21、提高循环体效率的根本方法是降低循环体的复杂性。【建议4-4-14-4-1】在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环放在最外层，以减少CPU跨切循环层的次数。例如例如4-4(b)的效率比例如4-4(a)的高。for(row=0;row100;row+)for(col=0;col5;col+)fum=sum+arowcol;例如4-4(a)低效率：长循环在最外层for(col=0;col5;col+)for(row=0;row100;row+)fum=sum+arowcol;例如4-4(b)高效率：长循环在最内层【建议4-4-24-4-2】如果循环体内存在逻辑判断，并且循环
22、次数很大，宜将逻辑判断移到循环体的外面。例如4-4(c)的程序比例如4-4(d)多执行了N-1次逻辑判断。并且由于前者老要进行逻辑判断，打断了循环“流水线作业，使得编译器不能对循环进行优化处理，降低了效率。如果N非常大，最好采用例如4-4(d)的写法，可以提高效率。如果N非常小，两者效率差异并不明显，采用例如4-4(c)的写法比拟好，因为程序更加简洁。for(i=0;iN;i+)if(conditionDoSomething();elseDoOtherthing();表4-4(c)效率低但程序简洁if(condition)for(i=0;iN;i+)DoSomething();elsefor(
23、i=0;iN;i+)DoOtherthing();表4-4(d)效率高但程序不简洁4.5for4.5for 语句的循环控制变量语句的循环控制变量【规那么4-5-14-5-1】不可在for循环体内修改循环变量，防止for循环失去控制。【建议4-5-14-5-1】建议for语句的循环控制变量的取值采用“半开半闭区间写法。例如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+)例
24、如4-5(a)循环变量属于半开半闭区间for(intx=0;x0)*pbTo+=*pbFrom+;returnpvTo;例如6-5复制不重叠的内存块assert不是一个仓促拼凑起来的宏。为了不在程序的 Debug版本和Release版本引起差异，assert不应该产生任何副作用。所以assert不是函数，而是宏。程序员可以把assert看成一个在任何系统状态下都可以平安使用的无害测试手段。如果程序在assertassert处终止了，并不是说含有该assertassert的函数有错误，而是调用者出了过失，assertassert可以帮助我们找到发生错误的原因。很少有比跟踪到程序的断言，却不知道该
25、断言的作用更让人沮丧的事了。你化了很多时间，不是为了排除错误，而只是为了弄清楚这个错误到底是什么。有的时候，程序员偶尔还会设计出有错误的断言。所以如果搞不清楚断言检查的是什么，就很难判断错误是出现在程序中，还是出现在断言中。幸运的是这个问题很好解决，只要加上清晰的注释即可。这本是显而易见的事情，可是很少有程序员这样做。这好比一个人在森林里，看到树上钉着一块“危险的大牌子。但危险到底是什么？树要倒？有废井？有野兽？除非告诉人们“危险是什么，否那么这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略，甚至被删除。【规那么6-5-16-5-1】使用断言捕捉不应该发生的非法情况。不要混淆非
26、法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。【规那么6-5-26-5-2】在函数的入口处，使用断言检查参数的有效性合法性。【建议6-5-16-5-1】在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？一旦确定了的假定，就要使用断言对假定进行检查。【建议6-5-26-5-2】一般教科书都鼓励程序员们进行防错设计，但要记住这种编程风格可能会隐瞒错误。当进行防错设计时，如果“不可能发生的事情确实发生了，那么要使用断言进行报警。6.66.6 引用与指针的比拟引用与指针的比拟引用是C+中的概念，初学者容易把引用和指针混淆一起。一下程序中，n是m的一个引用referen
27、ce，m是被引用物referent。int m;int&n=m;n相当于m的别名绰号，对n的任何操作就是对m的操作。例如有人名叫王小毛，他的绰号是“三毛。说“三毛怎么怎么的，其实就是对王小毛说三道四。所以n既不是m的拷贝，也不是指向m的指针，其实n就是m它自己。引用的一些规那么如下：1引用被创立的同时必须被初始化指针那么可以在任何时候被初始化。2不能有NULL引用，引用必须与合法的存储单元关联指针那么可以是NULL。3一旦引用被初始化，就不能改变引用的关系指针那么可以随时改变所指的对象。以下例如程序中，k被初始化为i的引用。语句k=j并不能将k修改成为j的引用，只是把k的值改变成为6。由于k是
28、i的引用，所以i的值也变成了6。int i=5;int j=6;int&k=i;k=j;/k和i的值都变成了6;上面的程序看起来象在玩文字游戏，没有表达出引用的价值。引用的主要功能是传递函数的参数和返回值。C+语言中，函数的参数和返回值的传递方式有三种：值传递、指针传递和引用传递。以下是“值传递的例如程序。由于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的指针，改变该指
29、针的内容将导致n的值改变，所以n的值成为10。void Func2(int*x)(*x)=(*x)+10;int n=0;Func2(&n);cout“n=nendl;/n=10以下是“引用传递的例如程序。由于Func3函数体内的x是外部变量n的引用，x和n是同一个东西，改变x等于改变n，所以n的值成为10。void Func3(int&x)x=x+10;int n=0;Func3(n);cout“n=nendl;/n=10比照上述三个例如程序，会发现“引用传递的性质象“指针传递，而书写方式象“值传递。实际上“引用可以做的任何事情“指针也都能够做，为什么还要“引用这东西？答案是“用适当的工具做恰如其分的工作。指针能够毫无约束地操作内存中的如何东西，尽管指针功能强大，但是非常危险。就象一把刀，它可以用来砍树、裁纸、修指甲、理发等等，谁敢这样用？如果确实只需要借用一下某个对象的“别名，那么就用“引用，而不要用“指针，以免发生意外。比方说，某人需要一份证明，本来在文件上盖上公章的印子就行了，如果把取公章的钥匙交给他，那么他就获得了不该有的权利。