高质量C编程.docx

1、高质量C编程高质量C+/C编程指南第1章 文件结构每个C+/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C+/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C+程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。1.1 版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/修改者，完成日期。

2、（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）函数和类结构声明等。

3、假设头文件名称为 graphics.h，头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。 【规则1-2-2】用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 【规则1-2-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 【建议1-2-1】头文件中只存放“声明”而不存放“定义”在C+ 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建

4、议将成员函数的定义与声明分开，不论该函数体有多么小。 【建议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 定义文件的结构定义文件有三部分内容：（

5、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语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解

6、释：（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5 目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。如果某些头

7、文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第2章 程序的版式 版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。2.1 空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会

8、多消耗一些纸张，但是值得。所以不要舍不得用空行。 【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1（a） 【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b ）/ 空行void Function1() / 空行void Function2() / 空行void Function3() / 空行while (condition) statement1; / 空行 if (condition) statement2; else statement3; / 空行 statement4; 示例2-1(a) 函数

9、之间的空行 示例2-1(b) 函数内部的空行2.2 代码行 【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 【规则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;

10、X a + b; y = c + d; z = e + f;if (width height) dosomething();if (width =”、“=”、“+”、“*”、“%”、“&”、“|”、“”这类操作符前后不加空格。 【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i10; i+)和if (a=b) & (c= 2000) / 良好的风格if(year=2000) / 不良的风格if (a=b) & (c=b&c=d) / 不良的风格for (i=0; i10; i+) / 良好的风格for(i=0;i10;i+)

11、/ 不良的风格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】 之内的代码块在右边数格处左对齐。示例2-4（a）为风格良好的对齐，示例2-4（b）为风格不良的对齐。void Function(int x) / program codevoid Function(int x) / program codeif (cond

12、ition) / program codeelse / program codeif (condition) / program codeelse / program codefor (initialization; condition; update) / program codefor (initialization; condition; update) / program codeWhile (condition) / program codewhile (condition) / program code如果出现嵌套的，则使用缩进对齐，如： 示例2-4(a) 风格良好的对齐 示例2-

13、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)& (very_longer_variable5 Draw(); / 类的成员函数 【规则3-1

14、-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如：int minValue;int maxValue;int SetValue();int GetValue(); 【建议3-1-1】尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。3.2 简单的Windows应用程序命名规则 作者对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用，比较适合于Windows应用软件的开发。 【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。例如： cla

15、ss 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），这样可以避免数据成员与成员函数的参数同名。例如：