高质量C语言编程

高质量嵌入式C语言编程FrancHE第1章文件结构第2章程序的版式第3章命名规则第4章表达式和基本语句第5章常量第6章函数设计第7章内存管理附录：其他方面的考虑第1章文件结构1.1版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/修改者，完成日期。（4）版本历史信息。/**Copyright(c)2001,上海贝尔有限公司网络应用事业部*Allrightsreserved.**文件名称：filename.h*文件标识：见配置管理计划书*摘要：简要描述本文件的内容**当前版本：1.1*作者：输入作者（或修改者）名字*完成日期：2001年7月20日**取代版本：1.0*原作者：输入原作者（或修改者）名字*完成日期：2001年5月10日*/示例1-11.2头文件的结构头文件由三部分内容组成：（1）头文件开头处的版权和版本声明（参见示例1-1）。（2）预处理块。（3）函数和类结构声明等。假设头文件名称为graphics.h，头文件的结构参见示例1-2。//版权和版本声明见示例1-1，此处省略。#ifndefGRAPHICS_H//防止graphics.h被重复引用#defineGRAPHICS_H//预处理#includemath.h//引用标准库的头文件…#include“myheader.h”//引用非标准库的头文件…voidFunction1(…);//全局函数声明示例1-2l【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。l【规则1-2-2】用#includefilename.h格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。l【规则1-2-3】用#include“filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。【建议1-2-2】不提倡使用全局变量，尽量不要在头文件中出现象externintvalue这类声明。1.3定义文件的结构(.c;.cpp)定义文件有三部分内容：（1）定义文件开头处的版权和版本声明（参见示例1-1）。（2）对一些头文件的引用。（3）程序的实现体（包括数据和代码）。假设定义文件的名称为graphics.cpp，定义文件的结构参见示例1-3。//版权和版本声明见示例1-1，此处省略。#include“graphics.h”//引用头文件…//全局函数的实现体voidFunction1(…){…}示例1-31.4头文件的作用C++/C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第2章程序的版式版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。2.1空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。l【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1（a）l【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b）//空行voidFunction1(…){…}//空行voidFunction2(…){…}//空行voidFunction3(…){…}示例2-1(a)函数之间的空行//空行if(condition){statement2;}else{statement3;}//空行statement4;}示例2-1(b)函数内部的空行2.2代码行l【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。l【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。【建议2-2-1】尽可能在定义变量的同时初始化该变量（就近原则）如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如intwidth=10;//定义并初绐化widthintheight=10;//定义并初绐化heightintdepth=10;//定义并初绐化depth示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。intwidth;//宽度intheight;//高度intdepth;//深度x=a+b;y=c+d;z=e+f;if(widthheight){dosomething();}for(initialization;condition;update){dosomething();}//空行other();示例2-2(a）intwidth,height,depth;//宽度高度深度X＝a+b;y=c+d;z=e+f;if(widthheight)dosomething();for(initialization;condition;update)dosomething();other();示例2-2(b)2.3代码行内的空格l【规则2-3-1】关键字之后要留空格。象const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。l【规则2-3-2】函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。l【规则2-3-3】‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。l【规则2-3-4】‘，’之后要留空格，如Function(x,y,z)。如果‘;’不是一行的结束符号，其后要留空格，如for(initialization;condition;update)。l【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“=”、“=”、“+”、“*”、“%”、“&&”、“||”、“”,“^”等二元操作符的前后应当加空格。l【规则2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。l【规则2-3-7】象“［］”、“.”、“-”这类操作符前后不加空格。【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for(i=0;i10;i++)和if((a=b)&&(c=d))voidFunc1(intx,inty,intz);//良好的风格voidFunc1(intx,inty,intz);//不良的风格if(year=2000)//良好的风格if(year=2000)//不良的风格if((a=b)&&(c=d))//良好的风格if(a=b&&c=d)//不良的风格for(i=0;i10;i++)//良好的风格for(i=0;i10;i++)//不良的风格for(i=0;I10;i++)//过多的空格x=ab?a:b;//良好的风格x=ab?a:b;//不好的风格int*x=&y;//良好的风格int*x=&y;//不良的风格array[5]=0;//不要写成array[5]=0;a.Function();//不要写成a.Function();b-Function();//不要写成b-Function();2.4对齐l【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。l【规则2-4-2】{}之内的代码块在‘{’右边数格处左对齐。示例2-4（a）为风格良好的对齐，示例2-4（b）为风格不良的对齐。voidFunction(intx){…//programcode}if(condition){…//programcode}else{…//programcode}for(initialization;condition;update){…//programcode}While(condition){…//programcode}如果出现嵌套的｛｝，则使用缩进对齐，如：{…{…}…}示例2-4(a)voidFunction(intx){…//programcode}if(condition){…//programcode}else{…//programcode}for(initialization;condition;update){…//programcode}while(condition){…//programcode}示例2-4(b)2.5长行拆分l【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。l【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。if((very_longer_variable1=very_longer_variable12)&&(very_longer_variable3=very_longer_variable14)&&(very_longer_variable5=very_longer_variable16)){dosomething();}virtualCMatrixCMultiplyMatrix(CMatrixleftMatrix,CMatrixrightMatrix);for(very_longer_initialization;very_longer_condition;very_longer_update){dosomething();}示例2-5长行的拆分2.6修饰符的位置修饰符*和＆应该靠近数据类型还是该靠近变量名，是个有争议的活题。若将修饰符*靠近数据类型，例如：int*x;从语义上讲此写法比较直观，即x是int类型的指针。上述写法的弊端是容易引起误解，例如：int*x,y;此处y容易被误解为指针变量。虽然将x和y分行定义可以避免误解，但并不是人人都愿意这样做。l【规则2-6-1】应当