C 模块化设计指南

在 C 语言中，合理分配 .h 文件和 .c 文件中的代码是模块化设计的核心。本文将系统介绍 .h 和 .c 文件的职责，以及文件之间的包含关系设计方法。

1. `.h` 文件（头文件）

.h 文件的主要作用是声明，而不是实现。它们通常包含以下内容：

放在 `.h` 文件中的内容

函数声明

对外提供的函数接口。
让其他模块知道如何调用这些函数。

// example.h
#ifndef EXAMPLE_H
#define EXAMPLE_H

void my_function(int x);

#endif

宏定义

全局通用的常量或简单的宏。

#define PI 3.14159
#define MAX_BUFFER_SIZE 1024

结构体、枚举和联合类型定义
- 如果是公共的结构体或类型，声明在头文件中。
```
typedef struct {
    int id;
    char name[50];
} Student;
```
全局变量的 extern 声明
- 全局变量本身定义在 .c 文件中，但其声明在头文件中。
```
extern int global_variable;
```
内联函数和小型宏
- 简单的、性能要求高的函数可以声明为 inline 并放在头文件中（由编译器决定是否内联）。
```
static inline int square(int x) {
    return x * x;
}
```

不应该放在 `.h` 文件中的内容

变量的定义（应使用 extern 声明）。
函数的实现代码（逻辑部分）。

2. `.c` 文件（源文件）

.c 文件主要负责实现逻辑，包含以下内容：

放在 `.c` 文件中的内容

头文件的包含
- 包括自己对应的头文件和必要的系统头文件。
```
#include "example.h"
#include <stdio.h>
```
函数的实现
- 所有声明在头文件中的函数，在 .c 文件中实现。
```
void my_function(int x) {
    printf("Value: %d\n", x);
}
```
私有函数和静态变量
- 仅供当前 .c 文件内部使用的函数和变量，使用 static 修饰以限制作用域。
```
static int helper_function(int x) {
    return x * x;
}

static int static_variable = 0;
```
全局变量的定义
- 声明在头文件中的 extern 全局变量，需要在 .c 文件中定义。
```
int global_variable = 42;
```

3. 文件之间的包含关系设计

在模块化设计中，文件之间的包含关系需要遵循以下原则：

对应的 .c 文件包含自己定义的头文件
- 确保 .c 文件实现的函数和 .h 文件声明的一致。
```
// example.c
#include "example.h"
```
其他文件使用模块时只包含头文件
- 不直接包含 .c 文件，而是通过头文件访问接口。
```
// main.c
#include "example.h"

int main() {
    my_function(10);
    return 0;
}
```

防止重复包含

使用 include guard 或 #pragma once。

#ifndef EXAMPLE_H
#define EXAMPLE_H
// 内容
#endif

依赖的头文件层次清晰
- 仅在需要的情况下包含依赖头文件，不滥用。
```
// example.h
#include <stdio.h> // 如果头文件中需要用到 printf
```

4. 模块化设计示例

以下是一个简单的模块化项目：

example.h

#ifndef EXAMPLE_H
#define EXAMPLE_H

void print_message(const char *message);
extern int global_count;

#endif

example.c

#include "example.h"
#include <stdio.h>

int global_count = 0;

void print_message(const char *message) {
    printf("Message: %s\n", message);
    global_count++;
}

main.c

#include "example.h"
#include <stdio.h>

int main() {
    print_message("Hello, World!");
    printf("Global count: %d\n", global_count);
    return 0;
}

编译和运行

gcc main.c example.c -o main
./main

输出

Message: Hello, World!
Global count: 1

总结

.h 文件：
- 声明接口，避免定义实现。
- 使用 include guard 避免重复包含。
.c 文件：
- 实现逻辑，定义全局变量。
- 使用 static 修饰私有变量和函数。
包含关系：
- .h 文件声明，.c 文件实现。
- 模块间通过头文件通信，保持低耦合性。

通过遵循这些规则，C 语言的模块化设计可以实现清晰、可维护和高复用的代码结构。

1. .h 文件（头文件）

放在 .h 文件中的内容

不应该放在 .h 文件中的内容

2. .c 文件（源文件）

放在 .c 文件中的内容