林锐博士的C++高质量代码的读书笔记，在毕业那年找工作的时候给与了很大帮助，即使工作了也很有益处。
无意中在本地电脑里找到了当年的笔记，重新整理下。
1.1 版权和版本的声明
主要内容有：(1) 版权信息。
(2) 文件名称，标识符，摘要。
(3) 当前版本号，作者/修改者，完成日期。
(4) 版本历史信息。
示例1-1
/*
- Copyright (c) 20XX, XXXX事业部
- All rights reserved.
- 文件名称：filename.h
- 文件标识：见配置管理计划书
- 摘 要：简要描述本文件的内容
- 当前版本：1.1
- 作 者：作者（或修改者）名字
- 完成日期：20XX年X月X日
- 取代版本：1.0
- 原 作 者 ：作者（或修改者）名字
- 完成日期：20XX年X月X日
*/
1.2 头文件的结构
头文件由三部分内容组成：(1) 头文件开头处的版权和版本声明
(2) 预处理块
(3) 函数和类结构声明等
规则 1-2-1 为了防止头文件被重复引用，应对用ifndef/define/endif结构产生预处理块。
规则 1-2-2 用#include<filename.h>格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。
规则 1-2-3 用#include "filename.h"格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。
建议 1-2-1 头文件中只存放“声明”而不存在“定义”。
建议 1-2-2 不提倡使用全局变量，尽量不要在头文件中出现像extern int value这类声明。
1.3 定义文件的结构
定义文件有三部分内容：(1) 定义文件开头处的版权和版本声明
(2) 对一些头文件的引用
(3) 程序的实现体（包括数据和代码）
1.4 头文件的作用
(1) 通过头文件来调用库功能。
(2) 头文件能加强类型安全检查。
1.5 目录结构
如果一个软件的头文件数目比较多，通常应将头文件和定义文件分别保存于不同的目录，以便于维护。
网友评论