// Replaced version  :  1.0 
// Original Author   : the name of original author(mender)
// Accomplished date : September 10, 2003
//
// Main functions    ：
//

Function 1 Return code     Function name(Parameter Explain)

//

Function 2 Return code     Function name(Parameter Explain)

//

...

//

Function n Return code     Function name(Parameter Explain)

////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////

示例 1-1 文件信息声明

☆ 【规则 1.1-1】

文件信息声明以两行斜杠开始，以两行斜杠结束，每一行都以两

个斜杠开始；

☆ 【规则 1.1-2】

文件信息声明包含五个部分，各部分之间以一空行间隔；

☆ 【规则 1.1-3】

在主要函数部分描述了文件所包含的主要函数的声明信息，如果
是头文件，这一部分是可以省略的。

1.2 头文件的结构

 

头文件由三部分内容组成：

(1) 头文件开头处的文件信息声明(参见示例 1-1)；
(2) 预处理块；
(3) 函数和类结构声明等。

 

假设头文件名称为 filesystem.h，头文件的结构参见示例 1-2。

☆ 【规则 1.2-1】

为了防止头文件被重复引用，应当用 ifndef/define/endif 结构产生

“

预处理块； #ifndef”

“

或者 #define”后以 TAB 键代替 SPACE 键做空

“

格；如果头文件名称是由多个单词组成，则各单词间以下划线 _”

“

连接，例如有头文件名称为 filesystem.h”

“

，则定义如下： #ifndef

_FILE_SYSTEM_H_”；

☆ 【规则 1.2-2】

 

用 #include <filename.h> 格式来引用标准库的头文件(编译器将

从标准库目录开始搜索)；

☆ 【规则 1.2-3】

 

用 #include “filename.h” 格式来引用非标准库的头文件(编译器将

从用户的工作目录开始搜索)；

☆ 【建议 1.2-1】

“

”

“

”

头文件中只存放 声明 而不存放 定义 ；

☆ 【建议 1.2-1】

头文件中应包含所有定义文件所定义的函数声明，如果一个头文
件对应多个定义文件，则不同定义文件内实现的函数要分开声明，

并作注释以解释所声明的函数从属于那一个定义文件；

☆ 【建议 1.2-3】

宏定义和函数声明分离，在两个头文件中定义，如果没有类成员

函数，可以将类和结构的定义与函数声明分离，也就是说一个头
文件专用于宏定义，一个头文件专用于类和结构的定义，一个头

文件专用于函数声明；

☆ 【建议 1.2-4】

在 C++ 语法中，类的成员函数可以在声明的同时被定义，并且自

动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不
一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数

体有多么小。