C++高质量编程指南笔记（一）

FileName.h

/*
*Copyright (c) 2016,11,XXXX公司
*All rights reserved

*文件名：FileName.h
*摘要：简要描述本文件的内容

*当前版本: 1.1
*作者：XXX
*完成日期：2007.1.1

*取代版本: 1.0
*作者：XXX2
*完成日期：2005.1.1

#ifndef FILENAME_H      //防止文件被重复引用
#define FILENAME_H

#include <filename.h>   //引用标准库头文件
...
#include "filename.h"   //引用非标准库头文件，将从用户的工作目录开始搜索
...
void Function();        //全局函数定义
...
Class Box
{
...
};              //类定义 类的函数成员在类声明时被定义自动成为内联函数
                //建议将声明和定义分开，不论该函数体多么小
                //不提倡使用全局变量，尽量不要在头文件中出现extern intvalue这类声明
#endif

FileName.cpp

/*
*Copyright (c) 2016,11,XXXX公司
*All rights reserved

*文件名：FileName.h
*摘要：简要描述本文件的内容

*当前版本: 1.1
*作者：XXX
*完成日期：2007.1.1

*取代版本: 1.0
*作者：XXX2
*完成日期：2005.1.1

void Funtion()          //全局函数的实现体
{
    ...
}

void Box::Draw()        //类成员函数的实现体
{
    ...
}

头文件作用

1、通过头文件来调用库功能。在很多场合，源代码不便或不准向用户公布，只要向用户提供头文件和二进制的库即可，用户只需按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现，编译器会自动从库中提取相应的代码。
2、头文件能加强类型安全检查，如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器会指出错误，这一简单的规则大大减轻程序员调试、改错的负担。

目录结构

1、如果一个软件的头文件数目比较多，通常应将头文件和定义文件分别保存于不同的目录，以便维护。例如.h放于include目录，将定义文件防御source目录
2、如果某些头文件是私有的，它不会被用户的程序直接调用，则没有必要公开其“声明”，为了加强信息隐藏，这些私有的头文件和定义文件存放于同一目录。