高质量C++/C编程指南
目 录
前 言
第 1 章 文件结构
1.1 版权和版本的声明
1.2 头文件的结构
1.3 定义文件的结构
1.4 头文件的作用
1.5 目录结构
第 2 章 程序的版式
2.1 空行
2.2 代码行
2.3 代码行内的空格
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 返回值的规则
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.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 章 其它编程经验
11.1 使用 const 提高函数的健壮性
11.2 提高程序的效率
11.3 一些有益的建议
参考文献
附录 A ： C++/C 代码审查表
附录 B ： C++/C 试题
附录 C ： C++/C 试题的答案与评分标准
前 言
软件质量是被大多数程序员挂在嘴上而不是放在心上的东西！
除了完全外行和真正的编程高手外，初读本书，你最先的感受将是惊慌：“哇！我以前捏造的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 图形学领域），动辄数万行程序，技术复杂，难度颇高。这些软件频频获奖，有一个软件获得首届中国大学生电脑大赛软件展示一等奖。在 1995 年开发的一套图形软件库到 2000 年还有人买。罗列出这些“业绩”，可以说明我算得上是编程高手了吧？
可惜这种个人感觉不等于事实。
读博期间我曾用一年时间开发了一个近 10 万行 C++ 代码的 3D 图形软件产品，我内心得意表面谦虚地向一位真正的软件高手请教。他虽然从未涉足过 3D 图形领域，却在几十分钟内指出该软件多处重大设计错误。让人感觉那套软件是用纸糊的华丽衣服，扯一下掉一块，戳一下破个洞。我目瞪口呆地意识到这套软件毫无实用价值，一年的心血白化了，并且害死了自己的软件公司。
人的顿悟通常发生在最心痛的时刻，在沮丧和心痛之后，我作了深刻反省，“面壁”半年，重新温习软件设计的基础知识。补修“内功”之后，又觉得腰板硬了起来。博士毕业前半年，我曾到微软中国研究院找工作，接受微软公司一位资深软件工程师的面试。他让我写函数 strcpy 的代码。
太容易了吧？
错！
这么一个小不点的函数，他从三个方面考查：
（ 1 ）编程风格；
（ 2 ）出错处理；
（ 3 ）算法复杂度分析（用于提高性能）。
在大学里从来没有人如此严格地考查过我的程序。我化了半个小时，修改了数次，他还不尽满意，让我回家好好琢磨。我精神抖擞地进“考场”，大汗淋漓地出“考场”。这“高手”当得也太窝囊了。我又好好地反省了一次。
我把反省后的心得体会写成文章放在网上传阅，引起了不少软件开发人员的共鸣。我因此有幸和国产大型 IT 企业如华为、上海贝尔、中兴等公司的同志们广泛交流。大家认为提高质量与生产率是软件工程要解决的核心问题。高质量程序设计是非常重要的环节，毕竟软件是靠编程来实现的。
我们心目中的老手们和高手们能否编写出高质量的程序来？
不见得都能！
就我的经历与阅历来看，国内大学的计算机教育压根就没有灌输高质量程序设计的观念，教师们和学生们也很少自觉关心软件的质量。勤奋好学的程序员长期在低质量的程序堆中滚爬，吃尽苦头之后才有一些心得体会，长进极慢，我就是一例。
现在国内 IT 企业拥有学士、硕士、博士文凭的软件开发人员比比皆是，但他们在接受大学教育时就“先天不足”，岂能一到企业就突然实现质的飞跃。试问有多少软件开发人员对正确性、健壮性、可靠性、效率、易用性、可读性（可理解性）、可扩展性、可复用性、兼容性、可移植性等质量属性了如指掌？并且能在实践中运用自如？。“高质量”可不是干活小心点就能实现的！
我们有充分的理由疑虑：
（ 1 ）编程老手可能会长期用隐含错误的方式编程（习惯成自然），发现毛病后都不愿相信那是真的！
（ 2 ）编程高手可以在某一领域写出极有水平的代码，但未必能从全局把握软件质量的方方面面。
事实证明如此。我到上海贝尔工作一年来，陆续面试或测试过近百名“新”“老”程序员的编程技能，质量合格率大约是 10 ％。很少有人能够写出完全符合质量要求的 if 语句，很多程序员对指针、内存管理一知半解， …… 。
领导们不敢相信这是真的。我做过现场试验：有一次部门新进 14 名硕士生，在开欢迎会之前对他们进行“ C++/C 编程技能”摸底考试。我问大家试题难不难？所有的人都回答不难。结果没有一个人及格，有半数人得零分。竞争对手公司的朋友们也做过试验，同样一败涂地。
真的不是我“心狠手辣”或者要求过高，而是很多软件开发人员对自己的要求不够高。
要知道华为、上海贝尔、中兴等公司的员工素质在国内 IT 企业中是比较前列的，倘若他们的编程质量都如此差的话，我们怎么敢期望中小公司拿出高质量的软件呢？连程序都编不好，还谈什么振兴民族软件产业，岂不胡扯。
我打算定义编程老手和编程高手，请您别见笑。
定义 1 ：能长期稳定地编写出高质量程序的程序员称为编程老手。
定义 2 ：能长期稳定地编写出高难度、高质量程序的程序员称为编程高手。
根据上述定义，马上得到第一推论：我既不是高手也算不上是老手。
在写此书前，我阅读了不少程序设计方面的英文著作，越看越羞惭。因为发现自己连编程基本技能都未能全面掌握，顶多算是二流水平，还好意思谈什么老手和高手。希望和我一样在国内土生土长的程序员朋友们能够做到：
（ 1 ）知错就改；
（ 2 ）经常温故而知新；
（ 3 ）坚持学习，天天向上。
二、本书导读
首先请做附录B的C++/C试题（不要看答案），考查自己的编程质量究竟如何。然后参照答案严格打分。
（1）如果你只得了几十分，请不要声张，也不要太难过。编程质量差往往是由于不良习惯造成的，与人的智力、能力没有多大关系，还是有药可救的。成绩越差，可以进步的空间就越大，中国不就是在落后中赶超发达资本主义国家吗？只要你能下决心改掉不良的编程习惯，第二次考试就能及格了。
（2）如果你考及格了，表明你的技术基础不错，希望你能虚心学习、不断进步。如果你还没有找到合适的工作单位，不妨到上海贝尔试一试。
（3）如果你考出85分以上的好成绩，你有义务和资格为你所在的团队作“C++/C编程”培训。希望你能和我们多多交流、相互促进。半年前我曾经发现一颗好苗子，就把他挖到我们小组来。
（4）如果你在没有任何提示的情况下考了满分，希望你能收我做你的徒弟。
编程考试结束后，请阅读本书的正文。
本书第一章至第六章主要论述C++/C编程风格。难度不高，但是细节比较多。别小看了，提高质量就是要从这些点点滴滴做起。世上不存在最好的编程风格，一切因需求而定。团队开发讲究风格一致，如果制定了大家认可的编程风格，那么所有组员都要遵守。如果读者觉得本书的编程风格比较合你的工作，那么就采用它，不要只看不做。人在小时候说话发音不准，写字潦草，如果不改正，总有后悔的时候。编程也是同样道理。
第七章至第十一章是专题论述，技术难度比较高，看书时要积极思考。特别是第七章“内存管理”，读了并不表示懂了，懂了并不表示就能正确使用。有一位同事看了第七章后觉得“野指针”写得不错，与我切磋了一把。可是过了两周，他告诉我，他忙了两天追查出一个Bug，想不到又是“野指针”出问题，只好重读第七章。
光看本书对提高编程质量是有限的，建议大家阅读本书的参考文献，那些都是经典名著。
如果你的编程质量已经过关了，不要就此满足。如果你想成为优秀的软件开发人员，建议你阅读并按照 CMMI 规范做事，让自己的综合水平上升一个台阶。上海贝尔的员工可以向网络应用事业部软件工程研究小组索取 CMMI 有关资料，最好能参加培训。
三、版权声明
本书的大部分内容取材于作者一年前的书籍手稿（尚未出版），现整理汇编成为上海贝尔网络应用事业部的一个规范化文件，同时作为培训教材。
由于 C++/C 编程是众所周知的技术，没有秘密可言。编程的好经验应该大家共享，我们自己也是这么学来的。作者愿意公开本书的电子文档。
版权声明如下：
（ 1 ）读者可以任意拷贝、修改本书的内容，但不可以篡改作者及所属单位。
（ 2 ）未经作者许可，不得出版或大量印发本书。
（ 3 ）如果竞争对手公司的员工得到本书，请勿公开使用，以免发生纠纷。
预计到 2002 年 7 月，我们将建立切合中国国情的 CMMI 3 级解决方案。届时，包括本书在内的约 1000 页规范将严格受控。
欢迎读者对本书提出批评建议。
林锐， 2001 年 7 月
第 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 版权和版本的声明
1.2 头文件的结构
头文件由三部分内容组成：
（ 1 ）头文件开头处的版权和版本声明（参见示例 1-1 ）。
（ 2 ）预处理块。
（ 3 ）函数和类结构声明等。
假设头文件名称为 graphics.h，头文件的结构参 见示例 1-2 。
l 【规则 1-2-1 】 为了防止头文件被重复引用，应当用 ifndef/define/endif 结构产生预处理块。
l 【规则 1-2-2 】 用 #include < filename.h> 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。
l 【规则 1-2-3 】 用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。
² 【建议 1-2-1 】 头文件中只存放“声明”而不存放“定义”
在 C++ 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小。
² 【建议 1-2-2 】 不提倡使用全局变量，尽量不要在头文件中出现象 extern int value 这类声明。
| // 版权和版本声明见示例 1-1 ，此处省略。
#ifndef GRAPHICS_H // 防止 graphics.h 被重复引用 #define GRAPHICS_H
#include … #include “myheader.h” // 引用非标准库的头文件 … void Function1(…); // 全局函数声明 … class Box // 类结构声明 { … }; #endif |
示例1-2 C++/C头文件的结构
1.3 定义文件的结构
定义文件有三部分内容：
（1） 定义文件开头处的版权和版本声明（参见示例 1-1 ）。
（2） 对一些头文件的引用。
（3） 程序的实现体（包括数据和代码）。
假设定义文件的名称为 graphics.cpp， 定义 文件的结构参 见示例 1-3 。
| // 版权和版本声明见示例 1-1 ，此处省略。
#include “graphics.h” // 引用头文件 …
// 全局函数的实现体 void Function1(…) { … }
// 类成员函数的实现体 void Box::Draw(…) { … } |
示例1-3 C++/C定义文件的结构
1.4 头文件的作用
早期的编程语言如 Basic 、 Fortran 没有头文件的概念， 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 ）
| // 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … }
|
// 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } |
示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行
2.2 代码行
l 【规则 2-2-1 】 一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
l 【规则 2-2-2 】 if 、 for 、 while 、 do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加 {} 。这样可以防止书写失误。
示例 2-2 （ a ）为风格良好的代码行，示例 2-2 （ b ）为风格不良的代码行。
|
int width; // 宽度 int height; // 高度 int depth; // 深度 |
int width, height, depth; // 宽度高度深度
|
| x = a + b; y = c + d; z = e + f; |
X ＝ a + b; y = c + d; z = e + f;
|
| if (width < height) { dosomething(); } |
if (width < height) dosomething(); |
| for (initialization; condition; update) { dosomething(); } // 空行 other();
|
for (initialization; condition; update) dosomething(); other();
|
示例2-2(a) 风格良好 的代码行 示例2-2(b) 风格不良 的代码行
² 【建议 2-2-1 】 尽可能在定义变量的同时初始化该变量（就近原则）
如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如
int width = 10; // 定义并初绐化width
int height = 10; // 定义并初绐化height
int depth = 10; // 定义并初绐化depth
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; 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=a |
| int *x = &y; // 良好的风格 int * x = & y; // 不良的风格 |
| array[5] = 0; // 不要写成 array [ 5 ] = 0; a.Function(); // 不要写成 a . Function(); b->Function(); // 不要写成 b -> Function();
|
示例2-3 代码行内的空格
2.4 对齐
l 【规则 2-4-1 】 程序的分界符‘ { ’和‘ } ’应独占一行并且位于同一列，同时与引用它们的语句左对齐。
l 【规则 2-4-2 】 { } 之内的代码块在‘ { ’右边数格处左对齐。
示例 2-4 （ a ）为风格良好的对齐，示例 2-4 （ b ）为风格不良的对齐。
|
void Function(int x) { … // program code } |
void Function(int x){ … // program code }
|
| if (condition) { … // program code } else { … // program code } |
if (condition){ … // program code } else { … // program code } |
| for (initialization; condition; update) { … // program code } |
for (initialization; condition; update){ … // program code } |
| While (condition) { … // program code } |
while (condition){ … // program code } |
| 如果出现嵌套的｛｝，则使用缩进对齐，如： { … { … } … } |
|
示例2-4(a) 风格良好 的对齐 示例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(); } |
| virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix, CMatrix rightMatrix);
|
| 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 】 应当将修饰符 * 和 ＆ 紧靠变量名
例如：
char *name;
int *x, y; // 此处y不会被误解为指针
2.7 注释
C 语言的注释符为“ /*…*/ ”。 C++ 语言中，程序块的注释常采用“ /*…*/ ”，行注释一般采用“ //… ”。注释通常用于：
（ 1 ）版本、版权声明；
（ 2 ）函数接口说明；
（ 3 ）重要的代码行或段落提示。
虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例 2-6 。
l 【规则 2-7-1 】 注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。
l 【规则 2-7-2 】 如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。例如
i++; // i 加 1，多余的注释
l 【规则 2-7-3 】 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
l 【规则 2-7-4 】 注释应当准确、易懂，防止注释有二义性 。错误的注释不但无益反而有害。
l 【规则 2-7-5 】 尽量避免在注释中使用缩写，特别是不常用缩写。
l 【规则 2-7-6 】 注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。
l 【规则 2-7-8 】 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。
|
/* * 函数介绍： * 输入参数： * 输出参数： * 返回值 ： */ void Function(float x, float y, float z) { … } |
if (…) { … while (…) { … } // end of while … } // end of if |
示例2-6 程序的注释
2.8 类的版式
类可以将数据和函数封装在一起，其中函数表示了类的行为（或称服务）。类提供关键字