📘 嵌入式C文档规范
30章 · 从入门到实战
📌
风格 · 活泼易读
01
文档价值
ROI·读者·必要性
为什么嵌入式项目需要文档？投入产出分析
→
02
文档类型
需求·设计·接口·手册
各类文档的区别与联系，如何选择
→
03
Doxygen入门
安装·Doxyfile
Doxygen是什么？基本配置与第一个文档
→
04
注释风格
JavaDoc vs Qt
嵌入式C项目选型建议与对比
→
05
文件头注释
版权·作者·修改记录
标准模板，每个.c/.h必备
→
06
函数注释
@brief @param @return
完整示例与规范用法
→
07
变量与宏
全局·静态·宏定义
避免过度注释，清晰表达
→
08
枚举与结构体
@enum @struct
复杂数据类型实战案例
→
09
Doxygen分组
@defgroup @ingroup
模块组织，文档结构清晰
→
10
生成HTML
运行Doxygen
配置输出选项，漂亮文档
→
11
生成PDF
Doxygen + LaTeX
中文支持与配置
→
12
版本控制
Git·Tag·版本号
文档与代码一起管理
→
13
Markdown应用
易读注释
在Doxygen注释中使用Markdown
→
14
图表流程图
@dot @uml
嵌入图表描述复杂逻辑
→
15
代码示例
@code @endcode
展示示例代码与格式注意
→
16
文档测试
@test标签
确保文档与代码一致
→
17
API文档
公共接口参考
为库/模块生成API手册
→
18
配置宏文档
@def
让用户知道如何裁剪功能
→
19
中断与回调
特殊函数注释
ISR、回调函数的要点
→
20
驱动层文档
寄存器·时序图
外设初始化、映射文档化
→
21
协议栈文档
数据包·状态机
通信协议文档化实践
→
22
RTOS任务文档
信号量·队列
任务函数、事件标志组注释
→
23
内存管理
堆栈·内存池·DMA
缓冲区文档化
→
24
错误处理
错误码·断言
异常处理流程文档化
→
25
文档审查
Checklist分享
代码审查时如何审查文档
→
26
CI/CD集成
自动化文档
每次提交自动生成文档
→
27
文档模板
完整项目模板
嵌入式C项目可直接复用
→
28
实战 I2C驱动
从零开始
完整文档编写过程
→
29
实战 FreeRTOS
任务·队列
应用项目文档生成
→
30
总结与展望
最佳实践·AI辅助
未来趋势与文档策略
→
⚙️📘