C语言项目开发常用目录结构 - Invinc

本文记录了C语言项目开发中常用的目录结构。

---

C 语言项目的目录规范没有统一标准，但行业中形成了一些通用的目录结构，目的是提高代码可维护性、分离不同类型的文件，尤其适合中大型项目。以下是一套经典且实用的目录规范，可根据项目规模灵活调整：

一、基础目录结构（中小型项目）

project_name/               # 项目根目录
├── src/                    # 源代码目录（核心逻辑）
│   ├── main.c              # 程序入口（main函数）
│   ├── module1/            # 模块1（如网络模块）
│   │   ├── module1.c       # 模块1实现
│   │   └── module1.h       # 模块1头文件（对外接口）
│   └── module2/            # 模块2（如工具函数）
│       ├── module2.c
│       └── module2.h
├── include/                # 公共头文件目录（供外部引用）
│   └── project_common.h    # 全局宏定义、类型定义等
├── lib/                    # 第三方库或静态/动态库
│   ├── libxxx.a            # 静态库
│   └── libxxx.so           # 动态库（Linux）/ libxxx.dll（Windows）
├── obj/                    # 编译生成的目标文件（.o/.obj）
├── bin/                    # 最终可执行文件
├── test/                   # 测试代码目录
│   ├── test_module1.c      # 模块1的单元测试
│   └── test.sh             # 测试脚本
├── docs/                   # 文档目录
│   ├── design.md           # 设计文档
│   └── api.md              # 接口文档
├── config/                 # 配置文件（如编译选项、环境配置）
│   └── config.ini
├── Makefile                # 编译脚本（核心，控制整个项目构建）
└── README.md               # 项目说明（功能、编译方式、使用方法）

---

二、目录说明（核心目录详解）

1. src/：源代码目录

   • 存放所有 .c 实现文件和模块内的私有 .h 头文件（仅模块内部使用）。
   • 按功能模块划分子目录（如 network/、utils/、storage/），避免所有文件堆在一起。

2. include/：公共头文件目录

   • 存放对外暴露的头文件（其他模块或外部项目需要引用的接口），确保 “实现私有化，接口公开化”。
   • 例如全局类型定义（typedef）、公共函数声明、宏定义（如 MAX_LEN）等。

3. lib/：库文件目录

   • 存放项目依赖的第三方库（如 libcurl、libmysql）或自己编译生成的库文件。
   • 静态库（.a）会被编译到可执行文件中，动态库（.so/.dll）则在运行时加载。

4. obj/：目标文件目录

   • 编译过程中生成的 .o（Linux）或 .obj（Windows）文件存放于此，避免污染源代码目录。
   • 可通过 Makefile 自动创建，编译完成后可删除（不影响可执行文件）。

5. bin/：可执行文件目录

   • 存放编译生成的最终程序（如 main、server），方便直接运行或部署。

6. test/：测试目录

   • 存放单元测试（如用 assert 或测试框架 Check 编写）、集成测试代码，确保模块功能正确性。

7. Makefile：构建核心

   • 定义编译规则（如依赖关系、编译选项 -Wall -O2、链接库 -lxxx），通过 make 命令一键编译。

   • 示例片段：

     CC = gcc
     CFLAGS = -Iinclude -Wall -O2  # 包含include目录，开启警告，优化
     LDFLAGS = -Llib -lxxx         # 链接lib目录下的libxxx库
     OBJ_DIR = obj
     BIN_DIR = bin# 编译目标文件
     $(OBJ_DIR)/main.o: src/main.c$(CC) $(CFLAGS) -c $< -o $@# 链接生成可执行文件
     $(BIN_DIR)/main: $(OBJ_DIR)/main.o $(OBJ_DIR)/module1.o$(CC) $^ -o $@ $(LDFLAGS)
     

---

三、大型项目扩展（可选）

• scripts/：存放构建脚本（如 build.sh）、部署脚本（deploy.sh）、清理脚本（clean.sh）。
• examples/：存放示例代码（如 demo.c），方便用户快速上手。
• logs/：运行时日志文件（需在代码中指定路径）。
• third_party/：存放第三方源码（如直接嵌入项目的开源库，而非预编译的 lib/）。

---

四、核心原则

1. 分离关注点：源代码、头文件、库、编译产物、文档严格分开。
2. 模块化：按功能拆分目录，每个模块内部高内聚，模块间低耦合。
3. 可扩展性：新增模块时只需在 src/ 下建子目录，修改 Makefile 即可，无需重构整体结构。

遵循规范可让项目结构清晰，方便团队协作和后期维护，尤其在多人开发或项目迭代时优势明显。

---