文件结构_高质量C++/C编程指南笔记

第一章 文件结构

.h			头文件：保存程序的声明
.c/.cpp		定义文件：保存程序的实现

1.1 版权和版本的声明

• 版权信息。
• 文件名称，标识符，摘要。
• 当前版本号，作者/修改这，完成日期。
• 版本历史信息。

/*
*Copyright	版权信息	All rights reserved
*
*文件名称：Learning.h
*文件标识：见配置管理计划书
*摘要：记录C++/C学习笔记
*
*当前版本：1.1
*作者：VonZhengzhi
*完成日期：2023.10.20
*
*取代版本：1.0
*作者：VonZhengzhi
*完成日期：2023.10.22
*/

1.2 头文件

1. 头文件开头处的版权和版本声明。
2. 预处理块。
3. 函数和类结构声明等。

//版权和版本声明

//假设头文件为graphics.h
#ifndef GRAPHICS_H // 防止 graphics.h 被重复引用 
#define GRAPHICS_H 
 
#include <math.h> // 引用标准库的头文件 
…
#include “myheader.h” // 引用非标准库的头文件 
… 
void Function1(…); // 全局函数声明 
… 
class Box // 类结构声明 
{ 
… 
}; 
#endif 

避免重复引用

头文件引用相当于直接把目标文件复制到此文件中，所以需要避免重复引用。需要利用ifndef/define/endif 结构产生预处理块。

#include“”与#include<>

#include<filename.h>用来引用标准库的头文件。编译器从标准库目录开始搜索。

#include"filename.h"用来引用非标准库（自己编写）的头文件。编译器从用户的工作目录开始搜索。

搜索路径不同提高引入编译效率，分类搜索思想，进行细化提高效率。

头文件的作用

• 通过头文件来调用库功能。源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可，类似于一种封装处理。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。
• 头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误。

注意

• 头文件中只存放“声明”，不存放“定义”。
• 不提倡使用全局变量，尽量不要在头文件中出现像extern int value这类声明
• 将成员函数的定义与声明分开，无论该函数体有多么小。

1.3 定义文件的结构

1. 定义文件开头处的版权和版本声明。
2. 对一些头文件的引用。
3. 程序的实现体（包括数据和代码）。

//版权和版本声明

#include<iostream>// 引用头文件
#include<math.h>
#include “graphics.h” 

// 全局函数的实现体 
void Function1(…) 
{ 
… 
} 
 
// 类成员函数的实现体 
void Box::Draw(…) 
{ 
… 
} 

1.4 目录结构

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

例如可将头文件保存于 include 目录，将定义文件保存于 source 目录（可以是多级 目录）。 如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声 明”。

为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。