软件 | 使嵌入式系统代码易于维护的 10 个技巧

来源:玩转单片机与嵌入式发布时间:2021-12-311036浏览

询问 AI

▼点击下方名片，关注公众号▼

欢迎关注【玩转单片机与嵌入式】公众号，回复关键字获取更多免费资料。

回复【加群】，限时免费进入知识共享群；

回复【3D封装库】，常用元器件的3D封装库；

回复【电容】，获取电容、元器件选型相关的内容；

回复【阻抗匹配】，获取电磁兼容性、阻抗匹配相关的资料

回复【资料】，获取全部电子设计、单片机开发相关的资料

回复【终端电阻】，获取CAN终端电阻相关的资料

回复【单片机】，获取单片机全套视频教程和参考设计

回复【STM32】，获取STM32相关设计和视频教程

回复【PCB】，获取PCB设计相关的资料

回复【硬件知识】、【硬件设计】，获取硬件开发工程必备手册

回复【经典电路】，获取5000个经典电路

回复【论文】，获取毕业设计、电子竞赛、学术专业等相关论文资料

…………

欢迎关注【玩转单片机与嵌入式】公众号，本公众号会每天输出高质量的技术干货文章，欢迎持续关注。

在匆忙推出产品的过程中，程序员经常忽略应用程序的一个关键方面——代码维护。

对于生命周期较短的应用程序，这种匆忙可能不会造成严重问题，因为一旦部署，没有人会再次接触代码。

然而，嵌入式系统应用程序的生命周期可能长达数十年，早期的编码错误可能会导致日后重大的错误修复和更新成本。

在为嵌入式应用程序设计和实现软件期间，您必须考虑代码的可维护性。以下的10个建议可能不是关于代码易维护的全部，但是遵守了这几个建议应该可以避免被看你代码的人“骂”：

避免汇编代码

在低端的一些微控制器（MCU）上可能只能用汇编语言，但是在高端的处理器上（如ARM），可能就不需要汇编语言。

我们在这里不能否认汇编语言的好处，在一些情况下，许多程序员可能会使用汇编语言来提高性能或减少代码大小。但是使用汇编语言代码可能会使您的项目延期，关键的，会让不懂汇编的人“看懵”。

当然了，有些位置或者情况你是不能避免使用汇编语言的，如果必须使用汇编语言，请包含详细的注释，这样可以节省时间并减少有人遇到问题时检查你的代码的挫败感。

代码注释要清晰

代码注释的作用应该就不需要解释了，好的注释确实可以很好的保证代码的可读和可维护性，但是相反；不好的代码注释反而会增大代码的误解；如下面的注释：

 This function adds two numbers and returns the resultintmultiply(inta, intb){returna*b;}

上面的代码明明是返回两个数字的乘积，但是注释中注释为范围两个数的和；让你说，后人看到这样的代码，会不会骂人？

03

不要随意优化代码

随意优化代码可能会导致维护噩梦，因为优化后的代码通常难以理解，并且，优化后的代码可能执行的效果与未优化前的效果天壤之别；若考虑到代码大小，内存空间限制等因素，请提前确定好代码的优化等级；
04

保持中断函数尽可能简单

简单的中断服务程序 (ISR) 可提高性能并简化维护。因为中断服务函数的运行是异步地，它们本质上很难调试；所以尽量减少他们的任务。尝试将任何数据处理或任务处理从 ISR 移到主程序中。然后，ISR 只负责从硬件获取数据，将其放入缓冲区，置位数据就绪标志并重新启用中断。
在主程序中通过判断就绪标志来执行数据的处理。
05

将调试代码留在源文件中

在程序开发过程中，我们可能会添加一些专门用于调试的代如：详细输出、断言、LED闪烁等。在项目结束时，删除调试代码以“清理”源代码可能很“爽”。但是，删除调试代码可能会在以后产生问题。任何试图维护应用程序代码的人都可能必须重新创建原始代码中包含的许多调试步骤。所以，将调试代码保留在源文件中可以简化维护。如果您必须在生产版本中删除调试代码，可以使用条件编译的方式保证在产生生产版本时不编译相关的调试代码。
06

将底层和应用层区分开

如果应用程序的代码中涉及到太多硬件相关的操作可能会使移植到新平台变得非常困难。所以，为了简化编程和应用层的维护，为硬件API或底层硬件操作封装自己的HAL层接口。当你的程序需要移植到新单片机上时，仅仅需要更改底层的代码就可以，定义的HAL层接口不需要改变，相对应的，应用层的代码也就不需要改变。

关于如何进行软件分层，我们会专门推出一系列的文章进行讲解；欢迎储蓄关注。

07

功能拆分需要合理

与 PC软件不同，嵌入式应用程序代码更多的依赖于硬件一起工作。因此，您可以选择将代码的功能单元分成不同的小块。将不同的功能拆分成不同的功能块，确实可以提高代码的易读和易维护性；但是进行功能拆分也不能太多；一般保持在单个作用域内的函数调用次数控制在5个或6个以内，并使软件中的功能单元与特定的硬件功能相对应。如果一个程序被分成太多的小块，调用图就会像蜘蛛网一样，代码将很难调试和理解。
08

保留所有代码相关的文档和流程图

我们在进行程序开发时，肯定会有一些功能说明、软件流程图等文档性质的内容，这些文档类的资料应尽可能与源文件放到一起，或直接添加到源代码工程中。如果您必须将文档分开，需要保证在代码中有相关的说明，说明文件的相关信息：如文件名、路径等信息。因为如果您不使用源代码找到文档，则很容易丢失文档。理想情况下，将完整应用程序的所有文档和源代码同一个工程目录下。保证后来人可以通过你的文章很快的熟悉你的代码。
09

避免使用一些巧妙的技巧

聪明的程序员可以想出极其紧凑和优雅的方法来使用模板、继承、goto 语句和三元运算符（“？”）等工具。但是这样聪明的编码方式可能会导致一些不必要的麻烦。因为可能只有在自己编写代码时才知道他们是怎么工作的，等过几天或者让后来人看你的代码时，肯定会一头雾水。因此，还是尽量减少使用这种深奥的语言功能。
10

将所有定义放在一处

如果您的代码包含许多常量定义或条件定义，请将它们保存在一个位置，例如单个文件或源代码目录。如果您在代码中藏着很多变量的定义，别人看到后可能会感觉代码太乱，变量随便定义，毫无规划。（当然了，不骂人最好了）