高质量C编程指南

高质量C++/C 编程指南
文件标识:
当前版本: 1.0
作 者: 林锐 博士
文件状态
[ ] 草稿文件
[√] 正式文件
[ ] 更改正式文件 完成日期: 2001 年7 月24 日
高质量C++/C 编程指南,v 1.0
2001 Page 2 of 101
版 本 历 史
版本/状态 作者 参与者 起止日期 备注
V 0.9
草稿文件
林锐
2001-7-1 至
2001-7-18
林锐起草
V 1.0
正式文件
林锐
2001-7-18 至
2001-7-24
朱洪海审查V 0.9,
林锐修正草稿中的错误
高质量C++/C 编程指南,v 1.0
2001 Page 3 of 101
目 录
前 言......................................................................................................................................6
第1 章 文件结构....................................................................................................................8
1.1 版权和版本的声明........................................................................................................8
1.2 头文件的结构...............................................................................................................8
1.3 定义文件的结构...........................................................................................................8
1.4 头文件的作用...............................................................................................................8
1.5 目录结构.......................................................................................................................8
第2 章 程序的版式................................................................................................................8
2.1 空行...............................................................................................................................8
2.2 代码行...........................................................................................................................8
2.3 代码行内的空格...........................................................................................................8
2.4 对齐...............................................................................................................................8
2.5 长行拆分.......................................................................................................................8
2.6 修饰符的位置...............................................................................................................8
2.7 注释...............................................................................................................................8
2.8 类的版式.......................................................................................................................8
第3 章 命名规则....................................................................................................................8
3.1 共性规则.......................................................................................................................8
3.2 简单的WINDOWS 应用程序命名规则.........................................................................8
3.3 简单的UNIX 应用程序命名规则..................................................................................8
第4 章 表达式和基本语句....................................................................................................8
4.1 运算符的优先级...........................................................................................................8
4.2 复合表达式...................................................................................................................8
4.3 IF 语句...........................................................................................................................8
4.4 循环语句的效率...........................................................................................................8
4.5 FOR 语句的循环控制变量............................................................................................8
4.6 SWITCH 语句..................................................................................................................8
4.7 GOTO 语句......................................................................................................................8
第5 章 常量............................................................................................................................8
5.1 为什么需要常量...........................................................................................................8
5.2 CONST 与 #DEFINE 的比较...........................................................................................8
5.3 常量定义规则...............................................................................................................8
5.4 类中的常量...................................................................................................................8
第6 章 函数设计....................................................................................................................8
高质量C++/C 编程指南,v 1.0
2001 Page 4 of 101
6.1 参数的规则...................................................................................................................8
6.2 返回值的规则...............................................................................................................8
6.3 函数内部实现的规则....................................................................................................8
6.4 其它建议.......................................................................................................................8
6.5 使用断言.......................................................................................................................8
6.6 引用与指针的比较........................................................................................................8
第7 章 内存管理....................................................................................................................8
7.1 内存分配方式................................................................................................................8
7.2 常见的内存错误及其对策.............................................................................................8
7.3 指针与数组的对比........................................................................................................8
7.4 指针参数是如何传递内存的?.....................................................................................8
7.5 FREE 和DELETE 把指针怎么啦?.................................................................................8
7.6 动态内存会被自动释放吗? ........................................................................................8
7.7 杜绝“野指针” ...........................................................................................................8
7.8 有了MALLOC/FREE 为什么还要NEW/DELETE ?.......................................................8
7.9 内存耗尽怎么办?........................................................................................................8
7.10 MALLOC/FREE 的使用要点.........................................................................................8
7.11 NEW/DELETE 的使用要点...........................................................................................8
7.12 一些心得体会.............................................................................................................8
第8 章 C++函数的高级特性.................................................................................................8
8.1 函数重载的概念...........................................................................................................8
8.2 成员函数的重载、覆盖与隐藏....................................................................................8
8.3 参数的缺省值...............................................................................................................8
8.4 运算符重载...................................................................................................................8
8.5 函数内联.......................................................................................................................8
8.6 一些心得体会...............................................................................................................8
第9 章 类的构造函数、析构函数与赋值函数.....................................................................8
9.1 构造函数与析构函数的起源........................................................................................8
9.2 构造函数的初始化表....................................................................................................8
9.3 构造和析构的次序........................................................................................................8
9.4 示例:类STRING 的构造函数与析构函数..................................................................8
9.5 不要轻视拷贝构造函数与赋值函数............................................................................8
9.6 示例:类STRING 的拷贝构造函数与赋值函数..........................................................8
9.7 偷懒的办法处理拷贝构造函数与赋值函数.................................................................8
9.8 如何在派生类中实现类的基本函数............................................................................8
9.9 一些心得体会...............................................................................................................8
第10 章 类的继承与组合......................................................................................................8
高质量C++/C 编程指南,v 1.0
2001 Page 5 of 101
10.1 继承.............................................................................................................................8
10.2 组合.............................................................................................................................8
第11 章 其它编程经验..........................................................................................................8
11.1 使用CONST 提高函数的健壮性..................................................................................8
11.2 提高程序的效率..........................................................................................................8
11.3 一些有益的建议..........................................................................................................8
参考文献................................................................................................................................8
附录A :C++/C 代码审查表................................................................................................8
附录B :C++/C 试题............................................................................................................8
附录C :C++/C 试题的答案与评分标准.............................................................................8
高质量C++/C 编程指南,v 1.0
2001 Page 6 of 101
前 言
软件质量是被大多数程序员挂在嘴上而不是放在心上的东西!
除了完全外行和真正的编程高手外,初读本书,你最先的感受将是惊慌:“哇!我
以前捏造的C++/C 程序怎么会有那么多的毛病?”
别难过,作者只不过比你早几年、多几次惊慌而已。
请花一两个小时认真阅读这本百页经书,你将会获益匪浅,这是前面N-1 个读者的
建议。
一、编程老手与高手的误区
自从计算机问世以来,程序设计就成了令人羡慕的职业,程序员在受人宠爱之后容
易发展成为毛病特多却常能自我臭美的群体。
如今在Internet 上流传的“真正”的程序员据说是这样的:
(1) 真正的程序员没有进度表,只有讨好领导的马屁精才有进度表,真正的程序员会让
领导提心吊胆。
(2) 真正的程序员不写使用说明书,用户应当自己去猜想程序的功能。
(3) 真正的程序员几乎不写代码的注释,如果注释很难写,它理所当然也很难读。
(4) 真正的程序员不画流程图,原始人和文盲才会干这事。
(5) 真正的程序员不看参考手册,新手和胆小鬼才会看。
(6) 真正的程序员不写文档也不需要文档,只有看不懂程序的笨蛋才用文档。
(7) 真正的程序员认为自己比用户更明白用户需要什么。
(8) 真正的程序员不接受团队开发的理念,除非他自己是头头。
(9) 真正的程序员的程序不会在第一次就正确运行,但是他们愿意守着机器进行若干个
30 小时的调试改错。
(10) 真正的程序员不会在上午9:00 到下午5:00 之间工作,如果你看到他在上午9:00 工
作,这表明他从昨晚一直干到现在。
……
具备上述特征越多,越显得水平高,资格老。所以别奇怪,程序员的很多缺点竟然
可以被当作优点来欣赏。就象在武侠小说中,那些独来独往、不受约束且带点邪气的高
手最令人崇拜。我曾经也这样信奉,并且希望自己成为那样的“真正”的程序员,结果
没有得到好下场。
我从读大学到博士毕业十年来一直勤奋好学,累计编写了数十万行C++/C 代码。有
这样的苦劳和疲劳,我应该称得上是编程老手了吧?
我开发的软件都与科研相关(集成电路CAD 和3D 图形学领域),动辄数万行程序,
技术复杂,难度颇高。这些软件频频获奖,有一个软件获得首届中国大学生电脑大赛软
高质量C++/C 编程指南,v 1.0
2001 Page 7 of 101
件展示一等奖。在1995 年开发的一套图形软件库到2000 年还有人买。罗列出这些“业
绩”,可以说明我算得上是编程高手了吧?
可惜这种个人感觉不等于事实。
读博期间我曾用一年时间开发了一个近10 万行C++代码的3D 图形软件产品,我内
心得意表面谦虚地向一位真正的软件高手请教。他虽然从未涉足过3D 图形领域,却在
几十分钟内指出该软件多处重大设计错误。让人感觉那套软件是用纸糊的华丽衣服,扯
一下掉一块,戳一下破个洞。我目瞪口呆地意识到这套软件毫无实用价值,一年的心血
白化了,并且害死了自己的软件公司。
人的顿悟通常发生在最心痛的时刻,在沮丧和心痛之后,我作了深刻反省,“面壁”
半年,重新温习软件设计的基础知识。补修“内功”之后,又觉得腰板硬了起来。博士
毕业前半年,我曾到微软中国研究院找工作,接受微软公司一位资深软件工程师的面试。
他让我写函数strcpy 的代码。
太容易了吧?
错!
这么一个小不点的函数,他从三个方面考查:
(1)编程风格;
(2)出错处理;
(3)算法复杂度分析(用于提高性能)。
在大学里从来没有人如此严格地考查过我的程序。我花了半个小时,修改了数次,
他还不尽满意,让我回家好好琢磨。我精神抖擞地进“考场”,大汗淋漓地出“考场”。
这“高手”当得也太窝囊了。我又好好地反省了一次。
我把反省后的心得体会写成文章放在网上传阅,引起了不少软件开发人员的共鸣。
我因此有幸和国产大型IT 企业如华为、上海贝尔、中兴等公司的同志们广泛交流。大
家认为提高质量与生产率是软件工程要解决的核心问题。高质量程序设计是非常重要的
环节,毕竟软件是靠编程来实现的。
我们心目中的老手们和高手们能否编写出高质量的程序来?
不见得都能!
就我的经历与阅历来看,国内大学的计算机教育压根就没有灌输高质量程序设计的
观念,教师们和学生们也很少自觉关心软件的质量。勤奋好学的程序员长期在低质量的
程序堆中滚爬,吃尽苦头之后才有一些心得体会,长进极慢,我就是一例。
现在国内IT 企业拥有学士、硕士、博士文凭的软件开发人员比比皆是,但他们在
接受大学教育时就“先天不足”,岂能一到企业就突然实现质的飞跃。试问有多少软件
开发人员对正确性、健壮性、可靠性、效率、易用性、可读性(可理解性)、可扩展性、
可复用性、兼容性、可移植性等质量属性了如指掌?并且能在实践中运用自如?。“高
质量”可不是干活小心点就能实现的!
高质量C++/C 编程指南,v 1.0
2001 Page 8 of 101
我们有充分的理由疑虑:
(1)编程老手可能会长期用隐含错误的方式编程(习惯成自然),发现毛病后都不愿相
信那是真的!
(2)编程高手可以在某一领域写出极有水平的代码,但未必能从全局把握软件质量的
方方面面。
事实证明如此。我到上海贝尔工作一年来,陆续面试或测试过近百名“新”“老”
程序员的编程技能,质量合格率大约是10%。很少有人能够写出完全符合质量要求的if
语句,很多程序员对指针、内存管理一知半解,……。
领导们不敢相信这是真的。我做过现场试验:有一次部门新进14 名硕士生,在开
欢迎会之前对他们进行“C++/C 编程技能”摸底考试。我问大家试题难不难?所有的人
都回答不难。结果没有一个人及格,有半数人得零分。竞争对手公司的朋友们也做过试
验,同样一败涂地。
真的不是我“心狠手辣”或者要求过高,而是很多软件开发人员对自己的要求不够
高。
要知道华为、上海贝尔、中兴等公司的员工素质在国内IT 企业中是比较前列的,
倘若他们的编程质量都如此差的话,我们怎么敢期望中小公司拿出高质量的软件呢?连
程序都编不好,还谈什么振兴民族软件产业,岂不胡扯。
我打算定义编程老手和编程高手,请您别见笑。
定义1:能长期稳定地编写出高质量程序的程序员称为编程老手。
定义2:能长期稳定地编写出高难度、高质量程序的程序员称为编程高手。
根据上述定义,马上得到第一推论:我既不是高手也算不上是老手。
在写此书前,我阅读了不少程序设计方面的英文著作,越看越羞惭。因为发现自己
连编程基本技能都未能全面掌握,顶多算是二流水平,还好意思谈什么老手和高手。希
望和我一样在国内土生土长的程序员朋友们能够做到:
(1)知错就改;
(2)经常温故而知新;
(3)坚持学习,天天向上。
高质量C++/C 编程指南,v 1.0
2001 Page 9 of 101
二、本书导读
首先请做附录B 的C++/C 试题(不要看答案),考查自己的编程质量究竟如何。然
后参照答案严格打分。
(1)如果你只得了几十分,请不要声张,也不要太难过。编程质量差往往是由于不良
习惯造成的,与人的智力、能力没有多大关系,还是有药可救的。成绩越差,可以进步
的空间就越大,中国不就是在落后中赶超发达资本主义国家吗?只要你能下决心改掉不
良的编程习惯,第二次考试就能及格了。
(2)如果你考及格了,表明你的技术基础不错,希望你能虚心学习、不断进步。如果
你还没有找到合适的工作单位,不妨到上海贝尔试一试。
(3)如果你考出85 分以上的好成绩,你有义务和资格为你所在的团队作“C++/C 编程”
培训。希望你能和我们多多交流、相互促进。半年前我曾经发现一颗好苗子,就把他挖
到我们小组来。
(4)如果你在没有任何提示的情况下考了满分,希望你能收我做你的徒弟。
编程考试结束后,请阅读本书的正文。
本书第一章至第六章主要论述C++/C 编程风格。难度不高,但是细节比较多。别小
看了,提高质量就是要从这些点点滴滴做起。世上不存在最好的编程风格,一切因需求
而定。团队开发讲究风格一致,如果制定了大家认可的编程风格,那么所有组员都要遵
守。如果读者觉得本书的编程风格比较合你的工作,那么就采用它,不要只看不做。人
在小时候说话发音不准,写字潦草,如果不改正,总有后悔的时候。编程也是同样道理。
第七章至第十一章是专题论述,技术难度比较高,看书时要积极思考。特别是第七
章“内存管理”,读了并不表示懂了,懂了并不表示就能正确使用。有一位同事看了第
七章后觉得“野指针”写得不错,与我切磋了一把。可是过了两周,他告诉我,他忙了
两天追查出一个Bug,想不到又是“野指针”出问题,只好重读第七章。
光看本书对提高编程质量是有限的,建议大家阅读本书的参考文献,那些都是经典
名著。
如果你的编程质量已经过关了,不要就此满足。如果你想成为优秀的软件开发人员,
建议你阅读并按照CMMI 规范做事,让自己的综合水平上升一个台阶。上海贝尔的员
工可以向网络应用事业部软件工程研究小组索取CMMI 有关资料,最好能参加培训。
高质量C++/C 编程指南,v 1.0
2001 Page 10 of 101
三、版权声明
本书的大部分内容取材于作者一年前的书籍手稿(尚未出版),现整理汇编成为上
海贝尔网络应用事业部的一个规范化文件,同时作为培训教材。
由于C++/C 编程是众所周知的技术,没有秘密可言。编程的好经验应该大家共享,
我们自己也是这么学来的。作者愿意公开本书的电子文档。
版权声明如下:
(1)读者可以任意拷贝、修改本书的内容,但不可以篡改作者及所属单位。
(2)未经作者许可,不得出版或大量印发本书。
(3)如果竞争对手公司的员工得到本书,请勿公开使用,以免发生纠纷。
预计到2002 年7 月,我们将建立切合中国国情的CMMI 3 级解决方案。届时,包
括本书在内的约1000 页规范将严格受控。
欢迎读者对本书提出批评建议。
林锐,2001 年7 月
高质量C++/C 编程指南,v 1.0
2001 Page 11 of 101
第1 章 文件结构
每个C++/C 程序通常分为两个文件。一个文件用于保存程序的声明(declaration),
称为头文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)
文件。
C++/C 程序的头文件以“.h”为后缀,C 程序的定义文件以“.c”为后缀,C++程序
的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。
1.1 版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有:
(1)版权信息。
(2)文件名称,标识符,摘要。
(3)当前版本号,作者/修改者,完成日期。
(4)版本历史信息。
/*
* Copyright (c) 2001,上海贝尔有限公司网络应用事业部
* All rights reserved.
*
* 文件名称:filename.h
* 文件标识:见配置管理计划书
* 摘 要:简要描述本文件的内容
*
* 当前版本:1.1
* 作 者:输入作者(或修改者)名字
* 完成日期:2001年7月20日
*
* 取代版本:1.0
* 原作者 :输入原作者(或修改者)名字
* 完成日期:2001年5月10日
*/
示例1-1 版权和版本的声明
高质量C++/C 编程指南,v 1.0
2001 Page 12 of 101
1.2 头文件的结构
头文件由三部分内容组成:
(1)头文件开头处的版权和版本声明(参见示例1-1)。
(2)预处理块。
(3)函数和类结构声明等。
假设头文件名称为 graphics.h,头文件的结构参见示例1-2。
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值