高质量C++编程指南笔记1：文件结构

一. 版权和版本的声明

版权和版本信息放在声明和实现文件的头部：

（1）版权信息。

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

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

（4）版本历史信息。  

/*
* Copyright (c) 2001,上海贝尔有限公司网络应用事业部
* All rights reserved.
*
* 文件名称：filename.h
* 文件标识：见配置管理计划书
* 摘    要：简要描述本文件的内容
*
* 当前版本：1.1
* 作    者：输入作者（或修改者）名字
* 完成日期： 2001年7月20日
*
* 取代版本：1.0
* 原作者  ：输入原作者（或修改者）名字
* 完成日期： 2001年5月10日
*/

二.头文件结构

头文件的组成：

（1）头文件开头处的版权和版本声明

（2）预处理块

（3）函数和类结构声明

[规则 1]用ifndef...define...endif预处理块防止重复引用头文件例如对于head.h的引用，通过如下的方式进行：

    #ifndef HEAD_H

    #define HEAD_H

    void fun();

    class Sample{

    ...

    }

    #endif

[规则 2]#include"..."自定义库，#include<...>标准库。

三.定义文件的结构

（1）版权与版本信息

（2）头文件引用  

（3）程序实现

四.头文件的作用

（1）对库进行调用

（2）根据库进行安全检查

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