高质量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 目次(可以是多级目次)。
假如某些头文件是私有的,它不会被用户的措施直接引用,则没有须要果真其“声明”。为了增强信息埋没,这些私有的头文件可以和界说文件存放于同一个目次。