高质量C /C编程指南 -- 第1章 文档结构

第 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” 格式来引用非标准库的头文档（编译器将从用户的工作目录开始搜索）。

2 【建议 1-2-1 】 头文档中只存放“声明”而不存放“定义”

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

2 【建议 1-2-2 】 不提倡使用全局变量，尽量不要在头文档中出现象 extern int value 这类声明。

// 版权和版本声明见示例 1-1 ，此处省略。 #ifndef GRAPHICS_H // 防止 graphics.h 被重复引用 #define GRAPHICS_H #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(…) { … }

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

1.4 头文档的作用

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

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

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

1.5 目录结构

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

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

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