高质量编程讲义.doc

《高质量编程讲义.doc》由会员分享，可在线阅读，更多相关《高质量编程讲义.doc（124页珍藏版）》请在金锄头文库上搜索。

1、 文件标识： 当前版本：1.0 作 者：林锐博士 文件状态 草稿文件 正式文件 更改正式文件 完成日期：2001 年 7 月 24 日 版本历史 版本/状态作者参与者起止日期备注 V 0.9 草稿文件 林锐 2001-7-1 至 2001-7-18 林锐起草 V 1.0 正式文件 林锐 2001-7-18 至 2001-7-24 朱洪海审查 V 0.9， 林锐修正草稿中的错误 目录 前言 第 1 章文件结构 1.1 版权和版本的声明 1.2 头文件的结构 1.3 定义文件的结构 1.4 头文件的作用 1.5 目录结构 第 2 章程序的版式 2.1 空行 2.2 代码行 2.3 代码行内的空格

2、2.4 对齐 2.5 长行拆分 2.6 修饰符的位置 2.7 注释 2.8 类的版式 第 3 章命名规则 3.1 共性规则 3.2 简单的 WINDOWS 应用程序命名规则 3.3 简单的 UNIX 应用程序命名规则 第 4 章表达式和基本语句 4.1 运算符的优先级 4.2 复合表达式 4.3 IF 语句 4.4 循环语句的效率 4.5 FOR 语句的循环控制变量 4.6 SWITCH 语句 4.7 GOTO 语句 第 5 章常量 5.1 为什么需要常量 5.2 CONST 与 #DEFINE 的比较 5.3 常量定义规则 5.4 类中的常量 第 6 章函数设计 6.1 参数的规则 6.2

3、返回值的规则 6.3 函数内部实现的规则 6.4 其它建议 6.5 使用断言 6.6 引用与指针的比较 第 7 章内存管理 7.1 内存分配方式 7.2 常见的内存错误及其对策 7.3 指针与数组的对比 7.4 指针参数是如何传递内存的？ 7.5 FREE 和 DELETE 把指针怎么啦？ 7.6 动态内存会被自动释放吗？ 7.7 杜绝“野指针” 7.8 有了 MALLOC/FREE 为什么还要 NEW/DELETE ？ 7.9 内存耗尽怎么办？ 7.10 MALLOC/FREE 的使用要点 7.11 NEW/DELETE 的使用要点 7.12 一些心得体会 第 8 章 C+函数的高级特性 8

4、.1 函数重载的概念 8.2 成员函数的重载、覆盖与隐藏 8.3 参数的缺省值 8.4 运算符重载 8.5 函数内联 8.6 一些心得体会 第 9 章类的构造函数、析构函数与赋值函数 9.1 构造函数与析构函数的起源 9.2 构造函数的初始化表 9.3 构造和析构的次序 9.4 示例：类 STRING 的构造函数与析构函数 9.5 不要轻视拷贝构造函数与赋值函数 9.6 示例：类 STRING 的拷贝构造函数与赋值函数 9.7 偷懒的办法处理拷贝构造函数与赋值函数 9.8 如何在派生类中实现类的基本函数 9.9 一些心得体会 第 10 章类的继承与组合 10.1 继承 10.2 组合 第 11

5、 章其它编程经验 11.1 使用 CONST 提高函数的健壮性 11.2 提高程序的效率 11.3 一些有益的建议 参考文献 附录 A ：C+/C 代码审查表 附录 B ：C+/C 试题 附录 C ：C+/C 试题的答案与评分标准 前言 软件质量是被大多数程序员挂在嘴上而不是放在心上的东西！ 除了完全外行和真正的编程高手外，初读本书，你最先的感受将是惊慌：“哇！我以前捏造的 C+/C 程序怎么会有那么多的毛病？” 别难过，作者只不过比你早几年、多几次惊慌而已。 请花一两个小时认真阅读这本百页经书，你将会获益匪浅，这是前面 N-1 个读者的建议。 一、编程老手与高手的误区 自从计算机问世以来，程

6、序设计就成了令人羡慕的职业，程序员在受人宠爱之后容易发展 成为毛病特多却常能自我臭美的群体。 如今在 Internet 上流传的“真正”的程序员据说是这样的： (1) (1) 真正的程序员没有进度表，只有讨好领导的马屁精才有进度表，真正的程序员会让领导提心吊胆。 (2) (2) 真正的程序员不写使用说明书，用户应当自己去猜想程序的功能。 (3) (3) 真正的程序员几乎不写代码的注释，如果注释很难写，它理所当然也很难读。 (4) (4) 真正的程序员不画流程图，原始人和文盲才会干这事。 (5) (5) 真正的程序员不看参考手册，新手和胆小鬼才会看。 (6) (6) 真正的程序员不写文档也不需要

7、文档，只有看不懂程序的笨蛋才用文档。 (7) (7) 真正的程序员认为自己比用户更明白用户需要什么。 (8) (8) 真正的程序员不接受团队开发的理念，除非他自己是头头。 (9) (9) 真正的程序员的程序不会在第一次就正确运行，但是他们愿意守着机器进行若干个 30 小时的调试 改错。 (10) (10)真正的程序员不会在上午 9:00 到下午 5:00 之间工作，如果你看到他在上午 9:00 工作，这表明他从 昨晚一直干到现在。 具备上述特征越多，越显得水平高，资格老。所以别奇怪，程序员的很多缺点竟然可以被 当作优点来欣赏。就象在武侠小说中，那些独来独往、不受约束且带点邪气的高手最令人崇拜。

8、 我曾经也这样信奉，并且希望自己成为那样的“真正”的程序员，结果没有得到好下场。 我从读大学到博士毕业十年来一直勤奋好学，累计编写了数十万行 C+/C 代码。有这样的苦劳和疲 劳，我应该称得上是编程老手了吧？ 我开发的软件都与科研相关（集成电路 CAD 和 3D 图形学领域），动辄数万行程序，技术复杂，难 度颇高。这些软件频频获奖，有一个软件获得首届中国大学生电脑大赛软件展示一等奖。在 1995 年开发 的一套图形软件库到 2000 年还有人买。罗列出这些“业绩”，可以说明我算得上是编程高手了吧？ 可惜这种个人感觉不等于事实。 读博期间我曾用一年时间开发了一个近 10 万行 C+代码的 3D

9、图形软件产品，我内心得意表面谦虚 地向一位真正的软件高手请教。他虽然从未涉足过 3D 图形领域，却在几十分钟内指出该软件多处重大设 计错误。让人感觉那套软件是用纸糊的华丽衣服，扯一下掉一块，戳一下破个洞。我目瞪口呆地意识到这 套软件毫无实用价值，一年的心血白化了，并且害死了自己的软件公司。 人的顿悟通常发生在最心痛的时刻，在沮丧和心痛之后，我作了深刻反省，“面壁”半年，重新温习 软件设计的基础知识。补修“内功”之后，又觉得腰板硬了起来。博士毕业前半年，我曾到微软中国研究院 找工作，接受微软公司一位资深软件工程师的面试。他让我写函数 strcpy 的代码。 太容易了吧？ 错！ 这么一个小不点的函

10、数，他从三个方面考查： （1）编程风格； （2）出错处理； （3）算法复杂度分析（用于提高性能）。 在大学里从来没有人如此严格地考查过我的程序。我化了半个小时，修改了数次，他还不 尽满意，让我回家好好琢磨。我精神抖擞地进“考场”，大汗淋漓地出“考场”。这“高手”当得也太 窝囊了。我又好好地反省了一次。 我把反省后的心得体会写成文章放在网上传阅，引起了不少软件开发人员的共鸣。我因此有幸和国 产大型 IT 企业如华为、上海贝尔、中兴等公司的同志们广泛交流。大家认为提高质量与生产率是软件工 程要解决的核心问题。高质量程序设计是非常重要的环节，毕竟软件是靠编程来实现的。 我们心目中的老手们和高手们能否

11、编写出高质量的程序来？ 不见得都能！ 就我的经历与阅历来看，国内大学的计算机教育压根就没有灌输高质量程序设计的观念， 教师们和学生们也很少自觉关心软件的质量。勤奋好学的程序员长期在低质量的程序堆中滚爬， 吃尽苦头之后才有一些心得体会，长进极慢，我就是一例。 现在国内 IT 企业拥有学士、硕士、博士文凭的软件开发人员比比皆是，但他们在接受大学教育时就 “先天不足”，岂能一到企业就突然实现质的飞跃。试问有多少软件开发人员对正确性、健壮性、可靠性、 效率、易用性、可读性（可理解性）、可扩展性、可复用性、兼容性、可移植性等质量属性了如指掌？并 且能在实践中运用自如？。“高质量”可不是干活小心点就能实现

12、的！ 我们有充分的理由疑虑： （1）编程老手可能会长期用隐含错误的方式编程（习惯成自然），发现毛病后都不愿相信那是真的！ （2）编程高手可以在某一领域写出极有水平的代码，但未必能从全局把握软件质量的方方面面。 事实证明如此。我到上海贝尔工作一年来，陆续面试或测试过近百名“新”“老”程序员的编程技能，质 量合格率大约是 10。很少有人能够写出完全符合质量要求的 if 语句，很多程序员对指针、内存管理一 知半解，。 领导们不敢相信这是真的。我做过现场试验：有一次部门新进 14 名硕士生，在开欢迎会之前对他们 进行“C+/C 编程技能”摸底考试。我问大家试题难不难？所有的人都回答不难。结果没有一个人

13、及格，有 半数人得零分。竞争对手公司的朋友们也做过试验，同样一败涂地。 真的不是我“心狠手辣”或者要求过高，而是很多软件开发人员对自己的要求不够高。 要知道华为、上海贝尔、中兴等公司的员工素质在国内 IT 企业中是比较前列的，倘若他们的编程质 量都如此差的话，我们怎么敢期望中小公司拿出高质量的软件呢？连程序都编不好，还谈什么振兴民族软 件产业，岂不胡扯。 我打算定义编程老手和编程高手，请您别见笑。 定义 1：能长期稳定地编写出高质量程序的程序员称为编程老手。 定义 2：能长期稳定地编写出高难度、高质量程序的程序员称为编程高手。 根据上述定义，马上得到第一推论：我既不是高手也算不上是老手。 在写

14、此书前，我阅读了不少程序设计方面的英文著作，越看越羞惭。因为发现自己连编程 基本技能都未能全面掌握，顶多算是二流水平，还好意思谈什么老手和高手。希望和我一样在 国内土生土长的程序员朋友们能够做到： （1）知错就改； （2）经常温故而知新； （3）坚持学习，天天向上。 二、本书导读 首先请做附录 B 的 C+/C 试题（不要看答案），考查自己的编程质量究竟如何。然后参照答案严格 打分。 （1）如果你只得了几十分，请不要声张，也不要太难过。编程质量差往往是由于不良习惯造成 的，与人的智力、能力没有多大关系，还是有药可救的。成绩越差，可以进步的空间就越大， 中国不就是在落后中赶超发达资本主义国家吗？

15、只要你能下决心改掉不良的编程习惯，第二次 考试就能及格了。 （2）如果你考及格了，表明你的技术基础不错，希望你能虚心学习、不断进步。如果你还没 有找到合适的工作单位，不妨到上海贝尔试一试。 （3）如果你考出 85 分以上的好成绩，你有义务和资格为你所在的团队作“C+/C 编程”培训。 希望你能和我们多多交流、相互促进。半年前我曾经发现一颗好苗子，就把他挖到我们小组来。 （4）如果你在没有任何提示的情况下考了满分，希望你能收我做你的徒弟。 编程考试结束后，请阅读本书的正文。 本书第一章至第六章主要论述 C+/C 编程风格。难度不高，但是细节比较多。别小看了，提高质量就 是要从这些点点滴滴做起。世

16、上不存在最好的编程风格，一切因需求而定。团队开发讲究风格一致，如果 制定了大家认可的编程风格，那么所有组员都要遵守。如果读者觉得本书的编程风格比较合你的工作，那 么就采用它，不要只看不做。人在小时候说话发音不准，写字潦草，如果不改正，总有后悔的时候。编程 也是同样道理。 第七章至第十一章是专题论述，技术难度比较高，看书时要积极思考。特别是第七章“内存管理”，读 了并不表示懂了，懂了并不表示就能正确使用。有一位同事看了第七章后觉得“野指针”写得不错，与我切 磋了一把。可是过了两周，他告诉我，他忙了两天追查出一个 Bug，想不到又是“野指针”出问题，只好重 读第七章。 光看本书对提高编程质量是有限的，建议大家阅读本书的参考文献，那些都是经典名著。 如果你的编程质量已经过关了，不要就此满足。如果你想成为优秀的软件开发人员，建议你阅读并 按照 CMMI 规范做事，让自己的综合水平上升一个台阶。上海贝尔的员工可以向网络应用事业部软件工 程研究小组索取 CMMI 有关资料，最好能参加培