为了正常的体验网站,请在浏览器设置里面开启Javascript功能!

C语言格式书写规范

2017-11-16 46页 doc 147KB 57阅读

用户头像

is_842972

暂无简介

举报
C语言格式书写规范C语言格式书写规范 C语言书写规范指南 第1章文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明(declaration),称为头 文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)文 件。 C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀。 1.1版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有: (1)版权信息。 (2)文件名称,标识符,摘要。 (3)当前版本号,作者/修改者,完成日期...
C语言格式书写规范
C语言格式书写规范 C语言书写规范指南 第1章文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明(declaration),称为头 文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)文 件。 C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀。 1.1版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有: (1)版权信息。 (2)文件名称,标识符,摘要。 (3)当前版本号,作者/修改者,完成日期。 (4)版本历史信息。 /* *Copyright(c)2001,吉林大学物理学院无线电 *Allrightsreserved. * *文件名称: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/#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=0x10; 定义。 【规则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)定义文件开头处的版权和版本声明(参见示例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)通过头文件来调用库功能。在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码。 (2)头文件能加强类型安全检查。如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。 1.5目录结构 如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。 例如可将头文件保存于 include 目录,将定义文件保存于 source 目录(可以是多级目录)。 如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。 第2章程序的版式 版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。 可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。 2.1空行 空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。 【规则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)函数内部的空行 2.2代码行 【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。 【规则2-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。 示例2-2(a)为风格良好的代码行,示例2-2(b)为风格不良的代码行。 int width;//宽度 int width,height,depth;//宽度高度深度 int height;//高度 int depth;//深度 中间使用TAB键控制距离 x = a+b; y=c+d;z=e+f; x = a+b; //等号左右用空格控制距离 y = c+d; z = e+f; if (width < height)//<左右用空格控制距离 if(width=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^” 等二元操作符的前后应当加空格。 【规则2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前 后不加空格。 【规则2-3-7】象“,,”、“.”、“->”这类操作符前后不加空格。 【建议2-3-1】对于达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些 空格,如for(i=0;i<10;i++)和if((a<=b)&&(c<=d)) void Func1(int x,int y,int z); //良好的风格 void Func1 (int x,int y,int z); //不良的风格 if (year >= 2000) //良好的风格 if(year>=2000) //不良的风格 if ((a>=b) && (c<=d)) //良好的风格 if(a>=b&&c<=d) //不良的风格 for (i=0; i<10; i++) //良好的风格 for(i=0;i<10;i++) //不良的风格 for(I = 0; I < 10; I++) //过多的空格 x = a < b ? a : b; //良好的风格 x=aFunction(); //不要写成b -> Function(); 示例2-3代码行内的空格 2.4对齐 【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。 【规则2-4-2】{}之内的代码块在‘{’右边一个TAB键处左对齐。 示例2-4(a)为风格良好的对齐,示例2-4(b)为风格不良的对齐。 void Function (int x) Void Function(intx){ { „//programcode „//programcode } } if (condition) if(condition){ { „//programcode „//programcode } } else else{ { „//programcode „//programcode } } for (initialization; condition; update) for(initialization;condition;update){ { „//programcode „//programcode } } while (condition) while(condition){ { „//programcode „//programcode } } 如果出现嵌套的,,,则使用缩进对齐,如: { „ { „ } „ } 示例2-4(a)风格良好的对齐 示例2-4(b)风格不良的对齐 2.5长行拆分 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛看 不过来,也不便于打印。 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突 出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。 if ((very_longer_variable1 >= very_longer_variable12) &&(very_longer_variable3 <= very_longer_variable14) 使用TAB键控制距离 &&(very_longer_variable5 <= very_longer_variable16)) { dosomething(); } Virtual CMatrixCMultiplyMatrix (CMatrixleftMatrix, CMatrixrightMatrix); 使用TAB键控制距离 For (very_longer_initialization; very_longer_condition; 使用TAB键控制距离 very_longer_update) { dosomething(); } 示例2-5长行的拆分 2.6修饰符的位置 修饰符*和,应该靠近数据类型还是该靠近变量名,是个有争议的活题。 若将修饰符*靠近数据类型,例如:int* x;从语义上讲此写法比较直观,即x是 int类型的指针。 上述写法的弊端是容易引起误解,例如:int* x,y;此处y容易被误解为指针变量。虽然将x和y分行定义可以避免误解,但并不是人人都愿意这样做。 【规则2-6-1】应当将修饰符*和,紧靠变量名例如: char *name; int *x,y; //此处y不会被误解为指针 2.7注释 C语言的注释符为“/*„*/”。C++语言中,程序块的注释常采用“/*„*/”,行注释一般采用“//„”。注释通常用于: (1)版本、版权声明; (2)函数接口; (3)重要的代码行或段落提示。虽然注释有助于理解代码,但注意不可过多地使用 注释。参见示例2-6。 【规则2-7-1】注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释 太多了会让人眼花缭乱。注释的花样要少。 【规则2-7-2】如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如 i++; //i加1,多余的注释 【规则2-7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致 性。不再有用的注释要删除。 【规则2-7-4】注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。 【规则2-7-5】尽量避免在注释中使用缩写,特别是不常用缩写。 【规则2-7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在 下方。 【规则2-7-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便 于阅读。 /* *函数介绍: *输入参数: *输出参数: *返回值 : */ Void Function(floatx, floaty, floatz) { „ if(„) { „ while(„) { „ }//endofwhile „ }//endofif } 示例2-6程序的注释 第3章命名规则 比较著名的命名规则当推Microsoft公司的“匈牙利”法,该命名规则的主要思想是 “在变量和函数名中加入前缀以增进人们对程序的理解”。例如所有的字符变量均以ch为前 缀,若是指针变量则追加前缀p。如果一个变量由ppch开头,则表明它是指向字符指针的指 针。 “匈牙利”法最大的缺点是烦琐,例如 int i, j, k; float x, y, z; 倘若采用“匈牙利”命名规则,则应当写成 int ii, ij, ik; //前缀i表示int类型 float fX, fY, fZ; //前缀f表示float类型如此 烦琐的程序会让绝大多数程序员无法忍受。 据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命 名规则。命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图发明 世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯 彻实施。绝对杜绝汉语拼音命名法 3.1共性规则 本节论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特定的规则,如3.2节。 【规则3-1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。标识符最好 采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。 程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成 NowValue。 【规则3-1-2】标识符的长度应当符合“min-length&&max-information”原则。 几十年前老ANSIC规定名字不准超过6个字符,现今的C不再有此限制。一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。那么名字是否越长约好,不见得!例如变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。 【规则3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。 例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。而 Unix应用程序的标识符通常采用“小写加下划线”的方式,如add_child。别把这两类风格混在一起用。 【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。例 如: int x, X; //变量x与X容易混淆 voidfoo(intx); //函数foo与FOO容易混淆 voidFOO(floatx); 【规则3-1-5】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域 不同而不会发生语法错误,但会使人误解。 【规则3-1-6】变量的名字应当使用“名词”或者“形容词,名词”。例 如: float value; float oldValue; float newValue; 【规则3-1-7】全局函数的名字应当使用“动词”或者“动词,名词”(动宾词组)。类的 成员函数应当只使用“动词”,被省略掉的名词就是对象本身。 例如: DrawBox(); //全局函数 box->Draw(); //类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如: int minValue; int maxValue; int SetValue(„); int GetValue(„); 【建议3-1-1】尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需 要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为 用数字编号最省事)。 3.2简单的Windows应用程序命名规则 作者对“匈牙利”命名规则做了合理的简化,下述的命名规则简单易用,比较适合于Windows应用软件的开发。 【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。 例如: class Node; //类名 class LeafNode; //类名 void Draw(void); //函数名 void SetValue(int value);//函数名 【规则3-2-2】变量和参数用小写字母开头的单词组合而成。例如: BOOL flag; 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),这样可以避免数据成员与成员函数 的参数同名。 例如: Void Object::SetValue(int width, int height) { m_width = width; m_height = height; } 【规则3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为 各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开 头,所有常量(或宏定义)均以GL开头。 第4章表达式和基本语句 表达式和语句都属于C的短语结构语法。它们看似简单,但使用时隐患比较多。本章归纳了 正确使用表达式和语句的一些规则与建议。 4.1运算符的优先级 C语言的运算符有数十个,运算符的优先级与结合律如表4-1所示。注意一元运算符+ - *的优先级高于对应的二元运算符。 优先级 运算符 结合律 从左至右 () [] -> . ! ~ ++ -- (类型)sizeof 从右至左 从 高 + - * & 从左至右 * / % 到从左至右 + - 低从左至右 << >> 排从左至右 < <= > >= 列 从左至右 == != 从左至右 & 从左至右 ^ 从左至右 | 从左至右 && 从右至左 || 从右至左 ?: 从左至右 = += -= *= /= %= &= ^= |= <<= >>= 表4-1运算符的优先级与结合律 【规则4-1-1】如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免使用默认 的优先级。 由于将表4-1熟记是比较困难的,为了防止产生歧义并提高可读性,应当用括号确定表达式的操作顺序。例如: word = (high<<8)|low if ((a|b)&&(a&c)) 4.2复合表达式 如a=b=c=0这样的表达式称为复合表达式。允许复合表达式存在的理由是: (1)书写简洁;(2)可以提高编译效率。但要防止滥用复合表达式。 【规则4-2-1】不要编写太复杂的复合表达式。例如: i=a>=b&&c=”或“<=”形式。 假设浮点变量的名字为x,应当将 if(x==0.0)//隐含错误的比较转化为 if((x>=-EPSINON)&&(x<=EPSINON)) 其中EPSINON是允许的误差(即精度)。 4.3.4指针变量与零值比较 【规则4-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.5对if语句的补充说明 有时候我们可能会看到if(NULL==p)这样古怪的格式。不是程序写错了,是程序 员为了防止将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; } 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; row<100; row++) { for (col=0; col<5; col++) { fum = sum+a[row][col]; } } 示例4-4(a)低效率:长循环在最外层 for (col=0; col<5; col++) { for (row=0; row<100; row++) { fum = sum+a[row][col]; } } 示例4-4(b)高效率:长循环在最内层 【建议4-4-2】如果循环体内存在逻辑判断,并且循环次数很大,宜将逻辑判断移到循环体的外面。示例4-4(c)的程序比示例4-4(d)多执行了N-1次逻辑判断。并且由于前者老要进行逻辑判断,打断了循环“流水线”作业,使得编译器不能对循环进行优化处理,降低了效率。如果N非常大,最好采用示例4-4(d)的写法,可以提高效率。如果N非常小,两者效率差别并不明显,采用示例4-4(c)的写法比较好,因为程序更加简洁。 for (i=0; i0) *pbTo++=*pbFrom++; returnpvTo; } 示例6-5复制不重叠的内存块 assert不是一个仓促拼凑起来的宏。为了不在程序的Debug版本和Release版本引起差别,assert不应该产生任何副作用。所以assert不是函数,而是宏。程序员可以把assert看成一个在任何系统状态下都可以安全使用的无害测试手段。如果程序在assert处终止了,并不是说含有该assert的函数有错误,而是调用者出了差错,assert可以帮助我们找到发生错误的原因。 很少有比跟踪到程序的断言,却不知道该断言的作用更让人沮丧的事了。你化了很多时间,不是为了排除错误,而只是为了弄清楚这个错误到底是什么。有的时候,程序员偶尔还会设计出有错误的断言。所以如果搞不清楚断言检查的是什么,就很难判断错误是出现在程序中,还是出现在断言中。幸运的是这个问题很好解决,只要加上清晰的注释即可。这本是显而易见的事情,可是很少有程序员这样做。这好比一个人在森林里,看到树上钉着一块“危险”的大牌子。但危险到底是什么,树要倒,有废井,有野兽,除非告诉人们“危险”是什么,否则这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略,甚至被删除。 【规则6-5-1】使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况 之间的区别,后者是必然存在的并且是一定要作出处理的。 【规则6-5-2】在函数的入口处,使用断言检查参数的有效性(合法性)。 【建议6-5-1】在编写函数时,要进行反复的考查,并且自问:“我打算做哪些假定,”一 旦确定了的假定,就要使用断言对假定进行检查。 【建议6-5-2】一般教科书都鼓励程序员们进行防错设计,但要记住这种编程风格可能 会隐瞒错误。当进行防错设计时,如果“不可能发生”的事情的确发生了,则要使用断 言进行报警。 6.6引用与指针的比较 引用是C++中的概念,初学者容易把引用和指针混淆一起。一下程序中,n是m的一个引用 (reference),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是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=”<答案
是“用适当的工具做恰如其分的工作”。 指针能够毫无约束地操作内存中的如何东西,尽管指针功能强大,但是非常危险。就象一把刀,它可以用来砍树、裁纸、修指甲、理发等等,谁敢这样用, 如果的确只需要借用一下某个对象的“别名”,那么就用“引用”,而不要用“指针”,以免发生意外。比如说,某人需要一份证明,本来在文件上盖上公章的印子就行了,如果把取公章的钥匙交给他,那么他就获得了不该有的权利。
/
本文档为【C语言格式书写规范】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。 本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。 网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。

历史搜索

    清空历史搜索