第一章 文件结构

林锐博士的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 目录结构
如果一个软件的头文件数目比较多,通常应将头文件和定义文件分别保存于不同的目录,以便于维护。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,314评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,043评论 25 709
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 47,032评论 6 342
  • 天气巨冷,已经是严冬了。 体验到自己还是急,急,急! 越是急于改善目前情况,越是得不到。 今天跟朋...
    徐丽红阅读 812评论 1 0
  • 文/木叶 2016-11-7 21:42 书翻罢, 思绪未能停。 入画河边垂柳绿, 秋来霜重叶临行。 不似旧时青。
    木__叶阅读 988评论 0 2