C/C++ 编程规范 1.0 学习 C1 头文件结构

1.1. 头文件 之 版权说明.

/////////////////////////////////////////////////
// 版权信息 Copyright(c) BIG集团,All Rights Reserved
// 创建者 Author: Ray
// 创建日期 Created: 2019/06/20
// 简要描述: Describe: 本文件功能
// 历史记录: 2019/06/25 IIbull 修改 列表.
/////////////////////////////////////////////////

1.2. 头文件之组成

版权说明
预处理块 (#ifndef/#define/#endif)
函数/类结构声明
建议:头文件中尽量只声明, 不定义. 即实现成员函数代码尽量拿到外边(虽然C++语法允许成员函数在声明的同时可以被定义, 并自动声成为内联函数), 如果需要以内联函数提升效率, 那么可以在外部实现部分加入 inline 关键字.
例如:
				
					
						
							点击(此处)折叠或打开
						
					
					
						/////////////////////////////////////////////////
// 版权信息 Copyright(c) BIG集团,All Rights Reserved
// 创建者 Author: Ray
// 创建日期 Created: 2019/06/20
// 简要描述: Describe: 本文件功能
// 历史记录: 2019/06/25 IIbull 修改 列表.
/////////////////////////////////////////////////

#ifndef _BIG_XCONFIG_INC_H_  //防止被重复引用
#define _BIG_XCONFIG_INC_H_

#include <math.h> //标准库的头文件, 必须使用<>. 编译器会标准库目录开始搜索
...
#include "big_core.h" //非标准库的头文件, 必须使用"" 编译器从用户工作目录开始搜素
...

namespace big    //命名空间
{
   class CBOX     //类结构声明
   {
    };
   ...
   void Func(...); //全局函数声明. 不允许在头文件中出现 extern CClassName obj的声明, 以防止全局对象初始化时, 多个类对象的构造和西沟函数调用顺序混乱. 可以使用全局函数代替去阿奴类类型变量.
}

#endif //_BIG_XCONFIG_INC_H_  //此处下面最好一行空行, 一遍兼容多种编译器.