参考学习资料 单片机 嵌入式单片机 C代码规范与风格_V11.docx

嵌入式单片机C代码规范与风格

作者：正点原子团队

I

嵌入式单片机C代码规范与风格

声明

本文档为正点原子嵌入式单片机(包括各类MCU芯片)C语言编程风格与规范说明文档，主要是针对正点原子开发团队的嵌入式软件开发，便于规范公司代码以及注释风格，方便阅读与维护，并养成良好的编程习惯，更好的完成团队开

发工作。

正点原子全部嵌入式软件开发人员必须遵守本文档的约束，对于Linux部门同事，可以针对性的参考《【正点原子】嵌入式LinuxC代码规范与风格.pdf》,本文档与《【正点原子】嵌入式LinuxC代码规范与风格.pdf》高度一致，但是稍有差异，更符合单片机教学使用，同时也便于单片机学习者向Linux开发转变，方

便后续发展。

对于各位读者，大家可以用根据自己喜欢编写代码，本文档仅提供参考意见，

并方便大家阅读正点原子的教程源码。

II

嵌入式单片机C代码规范与风格

声明 I

第一章规范说明 3

第二章排版格式和注释 4

2.1排版格式 5

2.1.1代码缩进 5

2.1.2代码行相关规范 5

2.1.3括号与空格 8

2.2注释 10

2.2.1注释风格 10

2.2.2文件信息注释 11

2.2.3函数的注释 12

2.2.4代码注释 14

第三章标识符命名 16

3.1命名规则 16

3.2文件命名 16

3.3变量命名 16

3.4函数命名 17

3.5宏命名 17

第四章函数 18

第五章变量 20

第六章宏和常量 22

3

嵌入式单片机C代码规范与风格

第一章规范说明

正点原子之前并没有对代码规范做强制性要求，导致代码规范性较差，随着团队壮大，有必要对正点原子开发团队的嵌入式C语言代码规范和风格做出约束，方便代码维护和团队协助。

对于新开发的各类单片机产品(开发板、模块、产品等)都必须遵循本文档的约束，规范代码编写和风格，对于老产品，也会逐步进行代码更新和重构，最终达到：统一风格、便于阅读、便于使用、便于移植、便于维护的目的。

代码规范整体需要做到以下几点：

1、简单、明了、清晰：

代码写出来重点是给人看的，因此简单、明了、清晰是第一要务!代码的可阅读性要高于代码的性能(除非你的代码以后不需要维护，那你写成啥样都无所谓)。简单、明了、清晰的代码也利于后期维护，尤其是当你写的代码交给他人去维护的时候，请不要祸害别人!

2、精简

代码越长越难看懂，这个大家应该都深有体会，一个1000多行的函数和一个最多100行的函数哪个好看?所以尽量将把函数写的精简。而且代码越长越容易出错，没有用的代码，变量等一定要及时的清理掉!功能类似或者重复的代码应尽可能提炼成一个函数。

3、保持第三方代码风格

公司内部代码风格必须做到统一，方便维护，如果有第三方代码(比如HAL库、FATFS、emWIN、各种OS、TGFX、Lwip、各种Lib等),出现风格冲突，应用程序还是以公司代码风格编写，与第三方代码的接口程序允许两种风格并存，切记不要去修改第三方代码风格。

4、减少封装

我们做嵌入式教学源码的时候，切忌对第三方代码库进行再封装，不要为了让第三方代码和我们的风格统一，而去修改第三方源码风格，或者重新写一套接口函数，以便和我们代码风格统一。

为了统一而再次封装第三方代码会对我们的教学产生不利影响，会给初学者带来困惑，比如ST官方的Cube库里面就为了兼容自己的代码风格，对FreeRTOS的API函数做了封装，结果很多客户就问我们为何ST官方所调用的任务创建函数和我们的FreeRTOS教程不同!他们之间有什么区别?他们之间没有任何区别，只是ST对其做了一个简单的封装，结果给学习者带来了困惑!如果不做这个封装的话虽然影响到了代码风格的统一，但是却给学习者减少了困惑，提高了学习效率，而提高客户的学习效率是我们的第一宗旨!

4

嵌入式单片机C代码规范与风格

第二章排版格式和注释

排版是为了在编写代码的时候按照“一定的规矩”来编写，主要目的是为了是代码清晰、易于阅读。注释顾名思义就为注释自己的代码，以方便他人阅读，尤其是尤其维护人员。优美的排版和言简意赅的注释可以提高阅读者的阅读效率，所以在编写代码之前一定要确定好自己打算采用的排版方式和注释方式。

5

正点原子嵌入式单片机C代码规范与风格

2.1排版格式

2.1.1代码缩进

代码缩