首页 规范C编程.pdf

规范C编程.pdf

规范C编程.pdf

上传者: estzxy923 2013-03-26 评分1 评论0 下载55 收藏0 阅读量934 暂无简介 简介 举报

简介:本文档为《规范C编程pdf》,可适用于电子通讯领域,主题内容包含高质量CC编程指南文件状态草稿文件正式文件更改正式文件文件标识:当前版本:作者:林锐博士完成日期:年月日高质量CC编程指南vPageof版本历史版本符等。

高质量CC编程指南文件状态草稿文件正式文件更改正式文件文件标识:当前版本:作者:林锐博士完成日期:年月日高质量CC编程指南vPageof版本历史版本状态作者参与者起止日期备注V草稿文件林锐至林锐起草V正式文件林锐至朱洪海审查V林锐修正草稿中的错误高质量CC编程指南vPageof目目录录前言第章文件结构版权和版本的声明头文件的结构定义文件的结构头文件的作用目录结构第章程序的版式空行代码行代码行内的空格对齐长行拆分修饰符的位置注释类的版式第章命名规则共性规则简单的WINDOWS应用程序命名规则简单的UNIX应用程序命名规则第章表达式和基本语句运算符的优先级复合表达式IF语句循环语句的效率FOR语句的循环控制变量SWITCH语句GOTO语句第章常量为什么需要常量CONST与#DEFINE的比较常量定义规则类中的常量第章函数设计高质量CC编程指南vPageof参数的规则返回值的规则函数内部实现的规则其它建议使用断言引用与指针的比较第章内存管理内存分配方式常见的内存错误及其对策指针与数组的对比指针参数是如何传递内存的?FREE和DELETE把指针怎么啦?动态内存会被自动释放吗?杜绝“野指针”有了MALLOCFREE为什么还要NEWDELETE?内存耗尽怎么办?MALLOCFREE的使用要点NEWDELETE的使用要点一些心得体会第章C函数的高级特性函数重载的概念成员函数的重载、覆盖与隐藏参数的缺省值运算符重载函数内联一些心得体会第章类的构造函数、析构函数与赋值函数构造函数与析构函数的起源构造函数的初始化表构造和析构的次序示例:类STRING的构造函数与析构函数不要轻视拷贝构造函数与赋值函数示例:类STRING的拷贝构造函数与赋值函数偷懒的办法处理拷贝构造函数与赋值函数如何在派生类中实现类的基本函数一些心得体会第章类的继承与组合高质量CC编程指南vPageof继承组合第章其它编程经验使用CONST提高函数的健壮性提高程序的效率一些有益的建议参考文献附录A:CC代码审查表附录B:CC试题附录C:CC试题的答案与评分标准高质量CC编程指南vPageof前言软件质量是被大多数程序员挂在嘴上而不是放在心上的东西!除了完全外行和真正的编程高手外初读本书你最先的感受将是惊慌:“哇!我以前捏造的CC程序怎么会有那么多的毛病?”别难过作者只不过比你早几年、多几次惊慌而已。请花一两个小时认真阅读这本百页经书你将会获益匪浅这是前面N个读者的建议。一、编程老手与高手的误区自从计算机问世以来程序设计就成了令人羡慕的职业程序员在受人宠爱之后容易发展成为毛病特多却常能自我臭美的群体。如今在Internet上流传的“真正”的程序员据说是这样的:()真正的程序员没有进度表只有讨好领导的马屁精才有进度表真正的程序员会让领导提心吊胆。()真正的程序员不写使用说明书用户应当自己去猜想程序的功能。()真正的程序员几乎不写代码的注释如果注释很难写它理所当然也很难读。()真正的程序员不画流程图原始人和文盲才会干这事。()真正的程序员不看参考手册新手和胆小鬼才会看。()真正的程序员不写文档也不需要文档只有看不懂程序的笨蛋才用文档。()真正的程序员认为自己比用户更明白用户需要什么。()真正的程序员不接受团队开发的理念除非他自己是头头。()真正的程序员的程序不会在第一次就正确运行但是他们愿意守着机器进行若干个小时的调试改错。()真明他从昨晚一直干到现在。……具备上述特征越多越显得水平高资格老。所以别奇怪程序员的很多缺点竟然可以被当作优点来欣赏。就象在武侠小说中那些独来独往、不受约束且带点邪气的高手最令人崇拜。我曾经也这样信奉并且希望自己成为那样的“真正”的程序员结果没有得到好下场。我从读大学到博士毕业十年来一直勤奋好学累计编写了数十万行CC代码。有这样的苦劳和疲劳我应该称得上是编程老手了吧?我开发的软件都与科研相关(集成电路CAD和D图形学领域)动辄数万行程序技术复杂难度颇高。这些软件频频获奖有一个软件获得首届中国大学生电脑大赛软件展示一等奖。在年开发的一套图形软件库到年还有人买。罗列出这些“业高质量CC编程指南vPageof绩”可以说明我算得上是编程高手了吧?可惜这种个人感觉不等于事实。读博期间我曾用一年时间开发了一个近万行C代码的D图形软件产品我内心得意表面谦虚地向一位真正的软件高手请教。他虽然从未涉足过D图形领域却在几十分钟内指出该软件多处重大设计错误。让人感觉那套软件是用纸糊的华丽衣服扯一下掉一块戳一下破个洞。我目瞪口呆地意识到这套软件毫无实用价值一年的心血白化了并且害死了自己的软件公司。人的顿悟通常发生在最心痛的时刻在沮丧和心痛之后我作了深刻反省“面壁”半年重新温习软件设计的基础知识。补修“内功”之后又觉得腰板硬了起来。博士毕业前半年我曾到微软中国研究院找工作接受微软公司一位资深软件工程师的面试。他让我写函数strcpy的代码。太容易了吧?错!这么一个小不点的函数他从三个方面考查:()编程风格()出错处理()算法复杂度分析(用于提高性能)。在大学里从来没有人如此严格地考查过我的程序。我化了半个小时修改了数次他还不尽满意让我回家好好琢磨。我精神抖擞地进“考场”大汗淋漓地出“考场”。这“高手”当得也太窝囊了。我又好好地反省了一次。我把反省后的心得体会写成文章放在网上传阅引起了不少软件开发人员的共鸣。我因此有幸和国产大型IT企业如华为、上海贝尔、中兴等公司的同志们广泛交流。大家认为提高质量与生产率是软件工程要解决的核心问题。高质量程序设计是非常重要的环节毕竟软件是靠编程来实现的。我们心目中的老手们和高手们能否编写出高质量的程序来?不见得都能!就我的经历与阅历来看国内大学的计算机教育压根就没有灌输高质量程序设计的观念教师们和学生们也很少自觉关心软件的质量。勤奋好学的程序员长期在低质量的程序堆中滚爬吃尽苦头之后才有一些心得体会长进极慢我就是一例。现在国内IT企业拥有学士、硕士、博士文凭的软件开发人员比比皆是但他们在接受大学教育时就“先天不足”岂能一到企业就突然实现质的飞跃。试问有多少软件开发人员对正确性、健壮性、可靠性、效率、易用性、可读性(可理解性)、可扩展性、可复用性、兼容性、可移植性等质量属性了如指掌?并且能在实践中运用自如?。“高质量”可不是干活小心点就能实现的!我们有充分的理由疑虑:高质量CC编程指南vPageof()编程老手可能会长期用隐含错误的方式编程(习惯成自然)发现毛病后都不愿相信那是真的!()编程高手可以在某一领域写出极有水平的代码但未必能从全局把握软件质量的方方面面。事实证明如此。我到上海贝尔工作一年来陆续面试或测试过近百名“新”“老”程序员的编程技能质量合格率大约是%。很少有人能够写出完全符合质量要求的if语句很多程序员对指针、内存管理一知半解……。领导们不敢相信这是真的。我做过现场试验:有一次部门新进名硕士生在开欢迎会之前对他们进行“CC编程技能”摸底考试。我问大家试题难不难?所有的人都回答不难。结果没有一个人及格有半数人得零分。竞争对手公司的朋友们也做过试验同样一败涂地。真的不是我“心狠手辣”或者要求过高而是很多软件开发人员对自己的要求不够高。要知道华为、上海贝尔、中兴等公司的员工素质在国内IT企业中是比较前列的倘若他们的编程质量都如此差的话我们怎么敢期望中小公司拿出高质量的软件呢?连程序都编不好还谈什么振兴民族软件产业岂不胡扯。我打算定义编程老手和编程高手请您别见笑。定义:能长期稳定地编写出高质量程序的程序员称为编程老手。定义:能长期稳定地编写出高难度、高质量程序的程序员称为编程高手。根据上述定义马上得到第一推论:我既不是高手也算不上是老手。在写此书前我阅读了不少程序设计方面的英文著作越看越羞惭。因为发现自己连编程基本技能都未能全面掌握顶多算是二流水平还好意思谈什么老手和高手。希望和我一样在国内土生土长的程序员朋友们能够做到:()知错就改()经常温故而知新()坚持学习天天向上。高质量CC编程指南vPageof二、本书导读首先请做附录B的CC试题(不要看答案)考查自己的编程质量究竟如何。然后参照答案严格打分。()如果你只得了几十分请不要声张也不要太难过。编程质量差往往是由于不良习惯造成的与人的智力、能力没有多大关系还是有药可救的。成绩越差可以进步的空间就越大中国不就是在落后中赶超发达资本主义国家吗?只要你能下决心改掉不良的编程习惯第二次考试就能及格了。()如果你考及格了表明你的技术基础不错希望你能虚心学习、不断进步。如果你还没有找到合适的工作单位不妨到上海贝尔试一试。()如果你考出分以上的好成绩你有义务和资格为你所在的团队作“CC编程”培训。希望你能和我们多多交流、相互促进。半年前我曾经发现一颗好苗子就把他挖到我们小组来。()如果你在没有任何提示的情况下考了满分希望你能收我做你的徒弟。编程考试结束后请阅读本书的正文。本书第一章至第六章主要论述CC编程风格。难度不高但是细节比较多。别小看了提高质量就是要从这些点点滴滴做起。世上不存在最好的编程风格一切因需求而定。团队开发讲究风格一致如果制定了大家认可的编程风格那么所有组员都要遵守。如果读者觉得本书的编程风格比较合你的工作那么就采用它不要只看不做。人在小时候说话发音不准写字潦草如果不改正总有后悔的时候。编程也是同样道理。第七章至第十一章是专题论述技术难度比较高看书时要积极思考。特别是第七章“内存管理”读了并不表示懂了懂了并不表示就能正确使用。有一位同事看了第七章后觉得“野指针”写得不错与我切磋了一把。可是过了两周他告诉我他忙了两天追查出一个Bug想不到又是“野指针”出问题只好重读第七章。光看本书对提高编程质量是有限的建议大家阅读本书的参考文献那些都是经典名著。如果你的编程质量已经过关了不要就此满足。如果你想成为优秀的软件开发人员建议你阅读并按照CMMI规范做事让自己的综合水平上升一个台阶。上海贝尔的员工可以向网络应用事业部软件工程研究小组索取CMMI有关资料最好能参加培训。高质量CC编程指南vPageof三、版权声明本书的大部分内容取材于作者一年前的书籍手稿(尚未出版)现整理汇编成为上海贝尔网络应用事业部的一个规范化文件同时作为培训教材。由于CC编程是众所周知的技术没有秘密可言。编程的好经验应该大家共享我们自己也是这么学来的。作者愿意公开本书的电子文档。版权声明如下:()读者可以任意拷贝、修改本书的内容但不可以篡改作者及所属单位。()未经作者许可不得出版或大量印发本书。()如果竞争对手公司的员工得到本书请勿公开使用以免发生纠纷。预计到年月我们将建立切合中国国情的CMMI级解决方案。届时包括本书在内的约页规范将严格受控。欢迎读者对本书提出批评建议。林锐年月高质量CC编程指南vPageof第章文件结构每个CC程序通常分为两个文件。一个文件用于保存程序的声明(declaration)称为头文件。另一个文件用于保存程序的实现(implementation)称为定义(definition)文件。CC程序的头文件以“h”为后缀C程序的定义文件以“c”为后缀C程序的定义文件通常以“cpp”为后缀(也有一些系统以“cc”或“cxx”为后缀)。版权和版本的声明版权和版本的声明位于头文件和定义文件的开头(参见示例)主要内容有:()版权信息。()文件名称标识符摘要。()当前版本号作者修改者完成日期。()版本历史信息。**Copyright(c),上海贝尔有限公司网络应用事业部*Allrightsreserved**文件名称:filenameh*文件标识:见配置管理计划书*摘要:简要描述本文件的内容**当前版本:*作者:输入作者(或修改者)名字*完成日期:年月日**取代版本:*原作者:输入原作者(或修改者)名字*完成日期:年月日*示例版权和版本的声明高质量CC编程指南vPageof头文件的结构头文件由三部分内容组成:()头文件开头处的版权和版本声明(参见示例)。()预处理块。()函数和类结构声明等。假设头文件名称为graphicsh头文件的结构参见示例。【规则】为了防止头文件被重复引用应当用ifndefdefineendif结构产生预处理块。【规则】用#include<filenameh>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。【规则】用#include“filenameh”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。【建议】头文件中只存放“声明”而不存放“定义”在C语法中类的成员函数可以在声明的同时被定义并且自动成为内联函数。这虽然会带来书写上的方便但却造成了风格不一致弊大于利。建议将成员函数的定义与声明分开不论该函数体有多么小。【建议】不提倡使用全局变量尽量不要在头文件中出现象externintvalue这类声明。版权和版本声明见示例此处省略。#ifndefGRAPHICSH防止graphicsh被重复引用#defineGRAPHICSH#include<mathh>引用标准库的头文件„#include“myheaderh”引用非标准库的头文件„voidFunction(„)全局函数声明„classBox类结构声明{„}#endif示例CC头文件的结构高质量CC编程指南vPageof定义文件的结构定义文件有三部分内容:()定义文件开头处的版权和版本声明(参见示例)。()对一些头文件的引用。()程序的实现体(包括数据和代码)。假设定义文件的名称为graphicscpp定义文件的结构参见示例。版权和版本声明见示例此处省略。#include“graphicsh”引用头文件„全局函数的实现体voidFunction(„){„}类成员函数的实现体voidBox::Draw(„){„}示例CC定义文件的结构头文件的作用早期的编程语言如Basic、Fortran没有头文件的概念CC语言的初学者虽然会用使用头文件但常常不明其理。这里对头文件的作用略作解释:()通过头文件来调用库功能。在很多场合源代码不便(或不准)向用户公布只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能而不必关心接口怎么实现的。编译器会从库中提取相应的代码。()头文件能加强类型安全检查。如果某个接口被实现或被使用时其方式与头文件中的声明不一致编译器就会指出错误这一简单的规则能大大减轻程序员调试、改错的负担。高质量CC编程指南vPageof目录结构如果一个软件的头文件数目比较多(如超过十个)通常应将头文件和定义文件分别保存于不同的目录以便于维护。例如可将头文件保存于include目录将定义文件保存于source目录(可以是多级目录)。如果某些头文件是私有的它不会被用户的程序直接引用则没有必要公开其“声明”。为了加强信息隐藏这些私有的头文件可以和定义文件存放于同一个目录。高质量CC编程指南vPageof第章程序的版式版式虽然不会影响程序的功能但会影响可读性。程序的版式追求清晰、美观是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然看得兴致勃勃。差的程序“书法”如螃蟹爬行让人看得索然无味更令维护者烦恼有加。请程序员们学习程序的“书法”弥补大学计算机教育的漏洞实在很有必要。空行空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存虽然打印含有空行的程序是会多消耗一些纸张但是值得。所以不要舍不得用空行。【规则】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例(a)【规则】在一个函数体内逻揖上密切相关的语句之间不加空行其它地方应加空行分隔。参见示例(b)空行voidFunction(„){„}空行voidFunction(„){„}空行voidFunction(„){„}空行while(condition){statement空行if(condition){statement}else{statement}空行statement}示例(a)函数之间的空行示例(b)函数内部的空行高质量CC编程指南vPageof代码行【规则】一行代码只做一件事情如只定义一个变量或只写一条语句。这样的代码容易阅读并且方便于写注释。【规则】if、for、while、do等语句自占一行执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。示例(a)为风格良好的代码行示例(b)为风格不良的代码行。intwidth宽度intheight高度intdepth深度intwidth,height,depth宽度高度深度x=aby=cdz=efX=aby=cdz=efif(width<height){dosomething()}if(width<height)dosomething()for(initializationconditionupdate){dosomething()}空行other()for(initializationconditionupdate)dosomething()other()示例(a)风格良好的代码行示例(b)风格不良的代码行【建议】尽可能在定义变量的同时初始化该变量(就近原则)如果变量的引用处和其定义处相隔比较远变量的初始化很容易被忘记。如果引用了未被初始化的变量可能会导致程序错误。本建议可以减少隐患。例如intwidth=定义并初绐化widthintheight=定义并初绐化heightintdepth=定义并初绐化depth高质量CC编程指南vPageof代码行内的空格【规则】关键字之后要留空格。象const、virtual、inline、case等关键字之后至少要留一个空格否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’以突出关键字。【规则】函数名之后不要留空格紧跟左括号‘(’以与关键字区别。【规则】‘(’向后紧跟‘)’、‘’、‘’向前紧跟紧跟处不留空格。【规则】‘’之后要留空格如Function(x,y,z)。如果‘’不是一行的结束符号其后要留空格如for(initializationconditionupdate)。【规则】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符如“=”、“=”“>=”、“<=”、“”、“*”、“”、“”、“||”、“<<”,“^”等二元操作符的前后应当加空格。【规则】一元操作符如“!”、“~”、“”、“”、“”(地址运算符)等前后不加空格。【规则】象“[]”、“”、“>”这类操作符前后不加空格。【建议】对于表达式比较长的for语句和if语句为了紧凑起见可以适当地去掉一些空格如for(i=i<i)和if((a<=b)(c<=d))voidFunc(intx,inty,intz)良好的风格voidFunc(intx,inty,intz)不良的风格if(year>=)良好的风格if(year>=)不良的风格if((a>=b)(

职业精品

酒店承包合同范本.doc

某企业人力资源制度.doc

员工离职处理原则.docx

PDF转word方法全面盘点1.doc

用户评论

0/200
    暂无评论
上传我的资料

精彩专题

相关资料换一换

资料评价:

/ 101
所需积分:0 立即下载

意见
反馈

返回
顶部