高质量C编程指南——第1章

第1章
文件结构

由于最近代码不规范，产生很多bug，所以需要认真的去读书，写质量高的代码。

1
 版权和版本的声明

      项目的.c文件和.h文件都需要，主要包括：

（1）版权信息

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

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

（4）版本历史信息

具体如下：

/*

*Copyright(c)2017,上海曹杨科技有限公司

*All rights reserved.

*

*文件名称：filename.h

*文件标识：见配置管理计划书

*摘    要：要来练习高质量代码

*

*当前版本：1.0

*作   者：曹杨

*完成日期：2017年12月07日

*

*取代版本：xxx

*原作者  ：xxx

*完成日期：xxx

*/

2
头文件的结构

主要有如下三部分内容组成：

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

（2） 预处理块

（3） 函数和类结构声明

假设头文件名称为graphics.h

具体如下：

//版权和版本声明见1 省略

#ifndef
GRAPHICS_H //防止graphics.h被重复引用

#define
GRAPHICS_H

#include<math.h>
//引用标准库的头文件

...

#include"myheader.h"
//引用非标准库的头文件

...

void Function(...);
//全局函数声明

...

class Box
//类结构声明

{

...

};

#endif

3
定义文件的结构

有三部分内容：

（1）定义文件开头出版权和版本声明

（2）对一些头文件的引用

（3）程序的实现体（包括数据和代码）

假设名称为graphics.cpp

//版权和版本声明见1  省略

#include “graphics.h”
//引用头文件

...

//全局函数实现体

void Function（...）

{

...

}

//类成员函数的实现体

void
Box：：Draw（...）

{

...

}

4
头文件的作用

（1）通过头文件调用库功能，很多场合，源码不便或不准向用户公布，编译器会从库中提取相应代码

（2）头文件能加强安全检查，如果接口被使用时，方式和头文件声明不一致，编译器就会指出错误，减轻程序
员调试、改错的负担。