C语言代码分层组织

##简述
C为函数式语言，使用模块化的设计会对开发大型项目带来很多好处。C的模块化也可以模拟一些OO的特点。
##层次化与模块化
C语言的应用领域，如通讯领域和嵌入式系统领域，一个的软件项目通常包含很多复杂的功能，实现这个项目不是一个程序员单枪匹马可以胜任的，往往需要一个团队的有效合作，另外，在一个以C代码为主的完整的项目中，经常也需要加入一些其他语言的代码，例如，C代码和汇编代码的混合使用，C文件和C++的同时使用。这些都增加了一个软件项目的复杂程度，为了提高软件质量，合理组织的各种代码和文件是非常重要的。
组织代码和文件的目的是为了使团队合作更加有效，使软件项目有良好的可扩展性、可维护性、可移植性、可裁减、可测试性，防止错误发生，提高软件的稳定性。通常情况下,软件项目采用层次化结构和模块化开发的方法,例如,一个嵌入式软件项目可能有驱动层,操作系统层,功能层,应用程序层,每一个层使用它的下层提供的接口,并为它的上层提供调用接口,模块则是每一个层中完成一个功能的单元,例如驱动层的每一个设备的驱动就是一个模块,应用层的每个应用程序就是一个模块,模块使用下层提供的接口和同层其他模块提供的接口,完成特定功能,为上层和同层的其他模块提供调用接口。

###接口
这里的接口是指一个功能模块暴露出来的，提供给其他模块的访问具体功能的方法。根据C语言的特点，使用*.c文件实现模块的功能，使用*.h文件暴露单元的接口,在*.h文件里声明外部其他模块可能使用的函数,数据类型,全局变量,类型定义,宏定义和常量定义.外部模块只需包含*.h文件就可以使用相应的功能.当然,模块可以再细化为子模块.虽然我们这里说的接口和COM(通用组件模型)里定义的接口不同,但是,根据COM里对接口的讨论,为了使软件在修改时,一个模块的修改不会导致其他模块也需要修改,所以,接口第一次发布后,修改*.h文件不能导致使用这个接口的其他模块需要重新编写。

###C code文件组织

• 使用层次化和模块化的软件开发模型.每一个模块只能使用所在层和下一层模块提供的接口
• 每个模块的文件包放在独立的一个文件夹中.通常情况下,实现一个模块的文件不止一个,这些相关的文件应该保存在一个文件夹中(Linux就是这样做的)
• 用于模块裁减的条件编译宏保存在一个独立的文件里,便于软件裁减
• 硬件相关代码和操作系统相关代码与纯C代码相对独立保存,以便于软件移植
• 声明和定义分开,使用*.h文件暴露模块需要提供给外部的函数,宏,类型,常量,全局变量,尽量做到模块对外部透明,用户在使用模块功能时不需要了解具体的实现,文件一旦发布,要修改一定要很慎重
• 文件夹和文件命名要能够反映出模块的功能
• 正式版本和测试版本使用统一文件，使用宏控制是否产生测试输出
• 必要的注释不可缺少。
  ###头文件内容
  理想的情况下，一个可执行的模块提供一个公开的接口，即使用一个*.h文件暴露接口，但是，有时候，一个模块需要提供不止一个接口，这时，就要为每个定义的接口提供一个公开的接口。在C语言的里，每个C文件是一个模块，头文件为使用这个模块的用户提供接口，用户只要包含相应的头文件就可以使用在这个头文件中暴露的接口。所有的头文件都建议参考以下的规则：
  ####第一条
  头文件中不能有可执行代码，也不能有数据的定义，只能有宏定义、类型声明（typedef,struct,union），数据和函数的声明。例如以下的代码可以包含在头文件里：

#define   NAMESTRING   “name”
typedef   unsign   long   word;
menu{
flag1;
flag2;
};
typedef   struct{
int   x;
int   y;
} Piont;
extent   Fun(void);
extent   int   a;

全局变量和函数的定义不能出现在*.h文件里。例如下面的代码不能包含在头文件：

int   a;
void   Fun1(void)
{
    a++;
}

####第二条
头文件中不能包本地数据（模块自己使用的数据或函数，不被其他模块使用）。这一点相当于面向对象程序设计里的私有成员，即只有模块自己使用的函数，数据，不要用extent在头文件里声明，只有模块自己使用的宏，常量，类型也不要在头文件里声明，应该在自己的*.c文件里声明。
####第三条
防止被重复包含。使用下面的宏防止一个头文件被重复包含：

#ifndef   MY_INCLUDE_H
#define   MY_INCLUDE_H
<头文件内容>
#endif

####第四条
包含extern “C”,使的程序可以在C++编译器被编译：

#ifdef   __cplusplus
extern   "C"{
#endif
<函数声明>
#ifdef   __cplusplus
    }
#enfif

被extern “C"修饰的变量和函数是按照C语言方式编译和连接的；未加extern “C”声明时的编译方式,作为一种面向对象的语言，C++支持函数重载，而过程式语言C则不支持。函数被C++编译后在符号库中的名字与C语言的不同。例如，假设某个函数的原型为：
void foo(int x, int y);该函数被C编译器编译后在符号库中的名字为_foo，而C++编译器则会产生像_foo_int_int之类的名字（不同的编译器可能生成的名字不同，但是都采用了相同的机制，生成的新名字称为“mangled name”）。_foo_int_int这样的名字包含了函数名、函数参数数量及类型信息，C++就是靠这种机制来实现函数重载的。例如，在C++中，函数
void foo(int x, int y)与
void foo(int x, float y)
编译生成的符号是不相同的，后者为_foo_int_float。　同样地，C++中的变量除支持局部变量外，还支持类成员变量和全局变量。用户所编写程序的类成员变量可能与全局变量同名，我们以”."来区分。而本质上，编译器在进行编译时，与函数的处理相似，也为类中的变量取了一个独一无二的名字，这个名字与用户程序中同名的全局变量名字不同。加extern "C"声明后的编译和连接,强制C++连接器按照C编译器产生的符号_foo链接。
####第五条
保证在使用这个头文件时，用户不用再包含使用此头文件的其他前提头文件，即要使用的头文件已经包含在此头文件里。例如：area.h头文件包含了面积相关的操作，要使用这个头文件不需同时包含了关于点操作的头文件piont.h。用户在使用area.h时不需要手动包含piont.h,因为我们已经在area.h中用＃include “point.h”包含了这个头文件。
####第六条
有一些头文件是为用户提供调用接口，这种头文件中声明了模块中需要给其他模块使用的函数和数据，鉴于软件质量上的考虑，处理参考以上的规则，用来暴露接口的头文件还需要参考更多的规则：

• 一个模块一个接口，不能几个模块用一个接口（一个模块可以多个接口）
• 文件名为和实现模块的c文件相同。abc.c–abc.h
• 尽量不要使用extern来声明一些共享的数据。因为这种做法是不安全的，外部其他模块的用户可能不能完全理解这些变量的含义，最好提供函数访问这些变量（数据隐藏性）
• 尽量避免包含其他的头文件，除非这些头文件是独立存在的。这一点的意思是，在作为接口的头文件中，尽量不要包含其他模块的那些暴露*.C文件中内容的头文件，但是可以包含一些不是用来暴露接口的头文件（如共享数据用的头文件）
• 不要包含那些只有在可执行文件中才使用的头文件，这些头文件应该在*.c文件中包含。这一点如同上一点，为了提高接口的独立性和透明度
• 接口文件要有面向用户的充足的注释。从应用角度描述个暴露的内容

####第七条
多个代码文件使用一个接口文件：这种头文件用于那些认为一个模块使用一个文件太大的情况。对于这种情况在参考上述建议后，也要参考以下建议：

• 多个代码文件组成的一个模块只有一个接口文件。因为这些文件完成的是一个模块
• 使用模块下文件命名<系统名><模块名命名>，如adc_read.c+adc_write.c
• 不要滥用这种文件
• 有时候也会出现几个*.c文件用于共享数据的*.h文件，这种文件的特点是在一个*.c文件里定义全局变量，而在其他*.c文件里使用，要将这种文件和用于暴露模块接口的文件区别
• 一个模块如果有几个子模块，可以用一个*.h文件暴露接口，在这个文件里用＃include包含每个子模块的接口文件
  ####第八条
• 包含一些需要的概念性的东西
• 命名方式,定义的功能.h
• 不包含任何其他的头文件.
• 不定义任何类型
• 不包含任何数据和函数声明
  ###一个头文件示例
  
  ###.c文件内容
  *.c文件是C语言中生成汇编代码和机器码的内容，要注意以下：
• 命名方式 模块名.c
• 用static修饰本地的数据和函数
• 不要使用extern。这是在*.h中使用的，可以被包含进来
• 无论什么时候定义内部的对象,确保独立于其他执行文件
• 这个文件里必须包含相应功能函数