第七章、文件结构
- 每个头文件和源文件的头部必须包含文件头部说明和修改记录。源文件和头文件的头部说明必须包含的内容和次序如下:
- 各个源文件必须有一个头文件说明,头文件各部分的书写顺序下:
- 源文件各部分的书写顺序如下:
- 需要对外公开的常量放在头文件中,不需要对外公开的常量放在定义文件的头部。
- 对于一个模块,如果要想用于多个编译器和/或多种语言的唯一条件是:相对应于这些编译器和语言,有一个共同的目标代码定义的接口标准。
对于一个模块,要是可能应用到不同的编译器的话,需要注意下面几点:
1堆栈的使用;
2参数的传递;
3数据的存储方式(长度、对准等);不同编译器处理数据大端和小端有区别,注意多字节或者位数据的存储。
INT、LONG数据类型不同的编译器对应不同的长度。不同的编译器变量
或者函数的地址长度不一样,如果将变量的地址作为参数传递,8位系统和32 位系统会不同。
对于大的常量宏定义,需要制定类型后缀。不过目前来讲,许多项目的移植工作主要是从一个系列的不同MCU 之间转换,或者16位与32位之间的转换。所以,建议重点关注数据的存储方式。 - 不应该在头文件中定义对象或函数体。头文件应该用于声明对象、函数、类型、宏。头文件不应该包含或处理占据空间的对象和函数体的定义(或者对象和函数的分段)。只有“.C”文件能包含可执行源代码,头文件只能包含声明。
如果对象的访问只是在单一的函数中,那么对象应该在块范围内声明。可能的情况下,对象的作用域应该限制在函数内。只有当对象需要具有内部或外部链接时,才能为其使用文件作用域。 - 在文件范围内使用的所有对象、函数的声明和定义,除非确有需要,否则应限定为只有本文件能使用。
每个源文件都有且只有一个头文件与之匹配。本模块的外部接口、外部变量等只能在本模块的头文件中声明,且声明的同时不加关键字extern;本模块的内部接口、内部变量等只能在本模块的源文件中声明(放源文件前部,函数内部变量放函数内部)和定义,且用static关键字修饰。如需使用外部变量或接口,需要在源文件前部显式的用extern声明。 - 宏定义、const修饰的只读变量必须且只能在一个头文件中声明。尽量用const修饰的只读变量替代宏定义。编译器会对const声明的只读变量做类型校验,而宏常量则不能。
- 文件标识符分为两部分,即文件名前缀和后缀。文件名前缀的最前面要使用范围限定符——模块名(文件名)缩写;
- 采用小写字母命名文件,避免使用一些比较通俗的文件名,如:public.c 等。