2022年12月26日 | 怎么看懂别人写的单片机项目代码

记得刚开始接触代码的时候，总觉得很神秘，也好奇到底是怎样的牛人，才能把这么多复杂的”天书”写出来去。

当时多希望自己一夜之间也拥有这种能力，能自己写代码去把自己的想法通过技术的手段制造出来。

现实哪有这么好的事，任何一项能力，必须都要经过破茧成蝶的痛苦过程。

记得我第一份单片机开发的工作，掉头发的数量也是历史之最，也是导致我现在发际线变高的罪魁祸首。

那个时候是第一次真正意义上去做实际产品开发，公司也没敢让我参与新产品研发，而是维护老产品，就是改改代码升级下产品功能。

我记得很清楚，当时要维护一个MF刷卡权限管理的控制板，用的是STC的单片机。

那个时候死磕MF卡的东西，比如说MF卡内部的扇区分布以及初始化流程，相当的复杂。

程序很多也没注释，有些注释甚至是错的，我足足研究了1个月，才摸到一点头绪。

其实当初是走了弯路，根本没必要去研究MF卡的初始化流程和寄存器配置。

因为那些一般都会有厂家提供，就像我们LCD驱动一样。

如果你去研究这个，所花的时间至少增加1倍，很不划算。

如果大家从事单片机开发，那看别人写的代码可以说是你的必经之路。

千万不要指望你的水平能通过同事帮助你提高，最后只能靠你自己付费另外去学习，或者你看那些大神写的代码慢慢去沉淀。

今天就跟大家分享下如何高效看懂别人的程序代码，这项能力决定你成长的速度，非常重要！

我也是培养了自己这项能力，才把一些很多协议栈挖的比较深。

比如说我把蓝牙协议栈的系统提取出来，去掉蓝牙部分代码，经过改良移植到STM32上面为己所用，实际比他们协议栈占用的资源更少。

当然，功能也没他们的强大，我们只需要够用就行。

如果用TI蓝牙芯片开发过产品的小伙伴应该对这个代码也比较熟悉了。

看别人代码是非常头痛的事情，现在我们无际单片机编程学到第二个项目的学员应该深有体会。

第二个项目的代码吃透就是3-5年工程师水平可不是说着玩的，毕竟是我多年经验总结，一下就想吃透不现实。

大家一定要记住，必须遵循正确的学习顺序去学习，否则很难吃透。

下面分享下个人的经验。

我总结以下几点：

1. 先看懂程序整体架构

2. 从main函数开始逐渐深入

3. 细节功能分析方法

一、先看懂程序整体架构

我们在拿到一个程序之前，先不急着看代码，先把整体架构捋清楚。

我拿我们主机那个项目来举例。

整个项目的程序可以拆分为三大板块：

实际上大多数单片机开发的项目都必备STM32外设驱动代码和产品功能代码。
系统内核代码，可能很多没有，这个类似于RTOS。

1.STM32外设驱动代码

也就是我们这个项目的主控芯片，这个板块主要是完成我们项目用到的STM32外设驱动代码。

这也是整个项目的基础，你必须要先熟悉STM32的外设怎么用起来，才能去研究产品功能代码，也就是第2,3板块。

可以利用现有的资源，比如说某子，某火的视频教程去学习STM32的外设使用。

2.系统内核代码

我们这个项目和传统产品代码不一样，传统的可能所有函数在while(1)死循环里面调用各种函数完成产品功能。

我们加入了一个自己写的小系统在里面，所有功能函数通过模拟任务管理的形式去执行，虽然最终也是在while(1)死循环里。

这样做的好处是可以灵活控制每个函数的执行频率和次数。

系统内核代码一般是一种程序框架，通用性比较强，所以相对比较复杂一点。

像这种代码，我不太建议新手上来就把它吃透，而是先学会移植。

就像RTOS一样，你不可能自己从头到尾写一个RTOS。

正确的学习顺序是，你先要移植，移植完以后知道怎么用。

用熟了以后，你慢慢也知道各个函数和变量的作用了，这个时候再去深挖实现的细节，最终吃透自己从零开始写出来。

这个非常重要，我发现很多新手没有这种意识。

总是纠结自己为什么写不出来，这是我几年经过数十产品锤炼出来的，看下教程就能写出来，这门槛未必也太低了对吧？

如果不纠正这个错误，很有可能你就卡在这个坎上了。

3.产品功能代码

刨去STM32外设驱动，刨去项目可能存在的系统，剩余的就是产品功能代码了。

二、从main函数开始逐渐深入

一个产品的功能再复杂，它都必须从main开始。

所以，我们分析程序的时候，一定要抓住程序的”喉咙”：main函数。

同样，在看代码之前，一定要对产品的功能有个系统的了解，否则就是看天书。

一般来说，只要你看的那个项目代码不会太差，main函数里通常都是通过调用各种函数去实现产品的功能。

而不会说直接在main函数里写所有功能的代码。

比如说我们这个程序，就是不同的功能模块，有不同的处理函数。

首先，我们先要熟悉每个功能模块需要实现的功能是什么，有了这个概念再去看代码。

最后通过AppProc这个函数完成各个功能模块的逻辑整合。

这些功能第一遍不需要吃透，你只需要知道大概先了解一下，用熟了再深入到细节实现。

三、细节功能分析方法

最后就是细节功能的分析了，细节功能是什么？

也就是我们产品的功能，比如说LED特效指示、按键检测、OLED菜单显示、蜂鸣器提示音等等。

这种要怎么去分析？

你先要熟悉功能，然后根据功能先想想如果是你，你要这么去实现这个功能？

自己先想一遍，甚至动手写一遍，不管有没有做出来，这时再去理解别人的代码。

思考一下，别人为什么要这么写，和你的写法有什么各自的优缺点，这一波操作虽然费时间，但是绝对值得你投入。

如果你连别人实现什么功能都不知道，就盲目去看代码，无疑是自讨苦吃走弯路。

我给大家举个简单的例子吧，比如让LED每秒闪1次这个功能的代码。

不同的工程师，经验和水平不一样，实现的方法肯定也不一样。

你想这个功能可能很简单，我就用一个定时器，定时频率是500ms，然后再定时中断里让LED控制引脚的电平翻转，这样就能实现LED每秒闪1次了。

但是你考虑过这样做的缺点没有？我总结一下：

①浪费资源

搞一个定时器专门用来做LED闪烁，这也太浪费了，一个单片机总共才多少个定时器？

②可扩展性差

如果下一次产品改板，加了10个灯，每个灯有不同的指示效果。

比如说：

LED1,要求产品未连上网以前每200ms闪1次，联网过程每400ms闪1次，连上网以后常亮。

LED2要求每按一个按键，就亮500ms，然后灭。

其他还有乱七八糟的特效，这种你试试用前面那种方式去实现，实现起来明显很麻烦！

所以，这就是为什么，明明你觉得很简单的功能，别人要绕一个大圈去实现。

就像我写的LED特效的程序，原理就是通过数组存储不同时间段引脚的状态，然后配合定时器把这个波形(PWM)在引脚里展现出来，实现不同LED特效的功能。

其实，如果你以前没做过LED特效的话，一下去理解别人踩过很多坑的代码是很困难的。

你要做的就是先要学会用，比如说你可以在我程序基础上改个特效试试。

等你真正学会了用，你会发现，你根本不用重头自己写，我这个代码都是通用性很强的。

你只需要把我代码移植到自己的产品上，根据自己产品需求，修改一些参数，就可以快速实现LED特效功能。

比如说，原来我的产品只有一个LED1，现在要新增加一个LED2，那你只需要在头文件LED枚举定义增加一个LED2：

当然，STM32的引脚配置，你也要增加一个GPIO来控制LED2。

就是要发散你的思维，先在我的代码框架基础去修改功能，然后烧录测试。

要不断循环这个过程，最终你才能吃透代码，而不是你光看视频去吃透，这个想法是错误的。

最后总结：

1. 拿到一个项目代码，先熟悉产品功能。

2. 熟悉产品的程序框架，都由哪些功能模块组成。

3. 多尝试改每个功能模块的代码，测试一下效果。

4. 改熟了再去分析他们具体实现的代码。

5. 尝试自己写。

反正，就是要先熟悉，再修改测试效果，最后再自己写。