嵌入式软件代码规范与版本管理实战 30 章 · 从规范到落地

01

代码规范总纲 概览

为什么嵌入式需要规范？MISRA C / GNU / Google Style 概览

02

命名规则 命名

匈牙利命名法、驼峰、下划线 · 变量/函数/宏/文件/结构体

03

注释规范 文档

文件头/函数头/行内注释 · TODO / FIXME 标记规范

04

排版与缩进 风格

K&R / Allman / Whitesmiths · 大括号位置 · 空格空行

05

函数设计规范 设计

函数长度 · 圈复杂度 · 单一职责 · 参数个数限制

06

变量与作用域 变量

全局/静态/局部变量 · volatile 正确使用

07

预处理器规范 预处理

宏定义 · 条件编译 · 头文件卫士 · #include 顺序

08

数据类型规范 类型

int8_t / uint32_t · 枚举 · 结构体对齐与填充

09

错误处理规范 错误

返回值检查 · assert · 错误码定义 · 异常策略

10

内存管理规范 内存

堆栈使用 · 动态内存限制 · 泄漏检测 · 指针规范

11

中断与并发规范 并发

ISR 编写 · 临界区保护 · 信号量 & 互斥锁

12

硬件抽象层 (HAL) 规范 HAL

寄存器访问 · 位操作 · 外设驱动接口设计

13

代码审查规范 审查

审查流程 · Checklist · Gerrit / GitLab MR

14

静态分析工具 分析

PC-Lint / Coverity / Cppcheck / SonarQube

15

单元测试规范 测试

Unity / CMock / Ceedling · 覆盖率要求

16

Git 基础 Git

工作流程 · 初始化 · commit · branch & merge

17

Git 进阶 进阶

rebase · cherry-pick · stash · submodule

18

Git 分支策略 分支

Git Flow / GitHub Flow / GitLab Flow / Trunk-Based

19

Commit 规范 提交

Conventional Commits · 语义化版本 · 格式

20

标签与发布 发布

Git tag · SemVer · Release Notes 编写

21

Git Hooks 与自动化 自动化

pre-commit / commit-msg 钩子 · CI/CD 集成

22

代码仓库管理 仓库

Monorepo vs Multi-repo · Fork & Pull Request

23

文档规范 文档

README · Doxygen · 设计文档 · CHANGELOG

24

持续集成 (CI) CI

Jenkins / GitLab CI / GitHub Actions · 自动化构建

25

持续部署 (CD) CD

固件发布 · OTA 更新 · 版本回滚策略

26

配置管理 配置

Kconfig · CMake · Makefile · 编译选项管理

27

依赖管理 依赖

第三方库引入 · Conan / vcpkg · 许可证合规

28

安全规范 安全

CWE Top 25 · 输入验证 · 缓冲区溢出 · 加密存储

29

团队协作规范 协作

代码所有权 · Code Review 文化 · 新人培训

30

综合实战 实战

从零搭建嵌入式项目 · 完整应用规范与版本管理