第一章 高质量C编程规范&文件结构

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

（1）版权信息。

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

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

（4）版本历史信息。

示例1

 

2. 头文件的结构

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

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

（2）预处理块。

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

说明：为了防止头文件被重复引用，应当用ifndef/define/endif 结构产生预处

理块；用 #include 格式来引用标准库的头文件（编译器将从

标准库目录开始搜索）；用 #include “filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索；建议头文件中只存放“声明”而不存放“定义”（不是强制的，但是几乎已经是一个默认的规则）。

在C++语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小。

示例2

// 版权和版本声明见示例1-1，此处省略。

#ifndef GRAPHICS_H // 防止graphics.h 被重复引用

#define GRAPHICS_H

#include // 引用标准库的头文件

…

#include “myheader.h” // 引用非标准库的头文件

…

void Function1(…); // 全局函数声明

…

class Box // 类结构声明

{

…

};

#endif

说明：#ifndefGRAPHICS_H这里一般都是将头文件的所有字母大写，头文件名中的点换为下划线，还有些地方会写为__GRAPHICS_H__这种形式，都是可以的。这只是保证这个宏只是跟本头文件相关（因为是从本头文件名转换而来的），如果这个宏没有被定义，那么就用#defineGRAPHICS_H将这个宏定义（这个宏只有宏名，但是没有被替换部分，是符合语法规则的），别的头文件中如果再来判断这个宏的时候就已经被定义了，用这个原理来防止重复引用。

3. 定义文件的结构

定义文件有三部分内容：

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

（2） 对一些头文件的引用。

（3） 程序的实现体（包括数据和代码）。

示例3

// 版权和版本声明见示例1-1，此处省略。

#include “graphics.h” // 引用头文件

…

// 全局函数的实现体

void Function1(…)

{

…

}

// 类成员函数的实现体

void Box::Draw(…)

{

…

}

4.头文件的作用

（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要

向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功

能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。

（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中

的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的

负担。

5. 目录结构

如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别

保存于不同的目录，以便于维护。

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

目录）。