C++的编程指南

序言：每天更新C++的内容

一、文件结构

每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。

C++/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C++程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。

1.1 版权和版本的声明

版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：

（1）版权信息。

（2）文件名称，标识符，摘要。

（3）当前版本号，作者/修改者，完成日期。

（4）版本历史信息。

/*

* Copyright (c) 时间  公司

* All rights reserved.

* 

* 文件名称：filename.h

* 文件标识：见配置管理计划书

* 摘    要：简要描述本文件的内容

*

* 当前版本：1.1

* 作    者：输入作者（或修改者）名字

* 完成日期：时间到日

*

* 取代版本：1.0

* 原作者  ：输入原作者（或修改者）名字

* 完成日期：时间到日

*/

 

示例1-1 版权和版本的声明

1.2 头文件的结构

头文件由三部分内容组成：

（1）头文件开头处的版权和版本声明（参见示例1-1）。

（2）预处理块。

（3）函数和类结构声明等。

假设头文件名称为 graphics.h，头文件的结构参见示例1-2。

【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。

【规则1-2-2】用 #include <filename.h> 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。

【规则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

//#ifndef GRAPHICS_H

//#define GRAPHICS_H

//#include<math.h>

//#include”myheader.h”

//Void Functionl()

//Class Box

#include <math.h> // 引用标准库的头文件

…

#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(…)//void Box::Draw

{

…

}

示例1-3 C++/C定义文件的结构

1.4 头文件的作用

早期的编程语言如Basic、Fortran没有头文件的概念，C++/C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：

（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。

（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。

1.5 目录结构

如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。

例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。

如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。

二、 程序的版式

版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。

可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。

2.1 空行

空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。

【规则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) 函数之间的空行                   示例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;	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 代码行内的空格

【规则2-3-1】关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。

【规则2-3-2】函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。

【规则2-3-3】‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。

【规则2-3-4】‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。

【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

【规则2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。

【规则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<b?a:b;                                // 不好的风格

int *x = &y;                              // 良好的风格  

int * x = & y;                            // 不良的风格  

array[5] = 0;                             // 不要写成 array [ 5 ] = 0;

a.Function();                             // 不要写成 a . Function();

b->Function();                            // 不要写成 b -> Function();

 

示例2-3 代码行内的空格

2.4 对齐

【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。

【规则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 长行拆分

【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。

【规则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分行定义可以避免误解，但并不是人人都愿意这样做。

【规则2-6-1】应当将修饰符 * 和 ＆ 紧靠变量名

例如：

char  *name;

int   *x, y; // 此处y不会被误解为指针

2.7 注释

C语言的注释符为“/*…*/”。C++语言中，程序块的注释常采用“/*…*/”，行注释一般采用“//…”。注释通常用于：

（1）版本、版权声明；

（2）函数接口说明；

（3）重要的代码行或段落提示。

虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例2-6。

【规则2-7-1】注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。

【规则2-7-2】如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。例如 

i++; // i 加 1，多余的注释

【规则2-7-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

【规则2-7-4】注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。

【规则2-7-5】尽量避免在注释中使用缩写，特别是不常用缩写。

【规则2-7-6】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。

【规则2-7-8】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

/* * 函数介绍： * 输入参数： * 输出参数： * 返回值  ： */ void Function(float x, float y, float z) {   … }

if (…) {   …   while (…)   { … } // end of while … } // end of if

示例2-6 程序的注释

2.8 类的版式

类可以将数据和函数封装在一起，其中函数表示了类的行为（或称服务）。类提供关键字public、protected和private，分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的，即让类仅仅公开必须要让外界知道的内容，而隐藏其它一切内容。我们不可以滥用类的封装功能，不要把它当成火锅，什么东西都往里扔。

类的版式主要有两种方式：

（1）将private类型的数据写在前面，而将public类型的函数写在后面，如示例8-3（a）。采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构。

（2）将public类型的函数写在前面，而将private类型的数据写在后面，如示例8.3（b）采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么样的接口（或服务）。

很多C++教课书受到Biarne Stroustrup第一本著作的影响，不知不觉地采用了“以数据为中心”的书写方式，并不见得有多少道理。

我建议读者采用“以行为为中心”的书写方式，即首先考虑类应该提供什么样的函数。这是很多人的经验——“这样做不仅让自己在设计类时思路清晰，而且方便别人阅读。因为用户最关心的是接口，谁愿意先看到一堆私有数据成员！”

class A {   private: int    i, j; float  x, y;     …   public: void Func1(void); void Func2(void); … }

class A {   public: void Func1(void); void Func2(void); …   private: int    i, j; float  x, y;     … }

示例8.3(a) 以数据为中心版式              示例8.3(b) 以行为为中心的版式

三、总结

学习C++编程需要有耐心也是需要注意细节，多规范自己的写法，对自己的习惯有莫大的好处，要勤加练习。

　　　　　　　　　　　　　　　　　　　　　　　　　　改变自己，从现在做起-----------久馆