嵌入式编程规范

目录

一、文件排版方面

头文件

二、注释方面

 1.文件头、函数头、全局常量变量、类型定义的注释格式

2.函数注释说明

三、命名方面

 通用命名规则

变量命名

函数命名

宏和枚举的命名规则

四、代码风格方面

 1.Tab和空格

2.函数 

3.代码块 

4.else 

5.代码行 

6.switch语句 

7.循环 

8.宏

9.goto 

五、类型

六、表达式

七、变量

八、宏、常量

九、函数

十、错误处理

十一、兼容性

十二、代码的编辑和编译

 十三、安全性

十四、可测性（酌情选择）

---

        编码规范是开发人员的基本要求，市面上编码规范文档，书籍都有。下面是本人多年的自己一个编码规范总结，希望能给各位带来帮助。

        下面链接是其他编程规范路径文档。

        「编程规范」https://www.aliyundrive.com/s/jUo4n1Z8BRN 提取码: nd72 点击链接保存，或者复制本段内容，打开「阿里云盘」APP ，无需下载极速在线查看，视频原画倍速播放。

一、文件排版方面

头文件

1.1头文件中适合放置接口的声明，不适合放置实现。头文件中应放置对外部的声明，内部使用的函数、宏、枚举、类型、变量定义等不应放在头文件中。

1.2每一个.c 文件应有一个同名.h 文件，用于声明需要对外公开的接口。

禁止头文件循环依赖。例如a.h包含b.h，b.h包含c.h，c.h包含a.h。如果其中任何一个头文件被修改，都导致所有包含了a.h/b.h/c.h 的代码全部重新编译一遍。

1.3 文件禁止包含用不到的文件，否则可能会增加编译时间。

1.4头文件应当自包含，简单理解任意一个头文件均可独立编译。例如，每个使用a.h 头文件的.c 文件，为了让引入的a.h 的内容编译通过，都要包含额外的头文件b.h 。额外的头文件b.h 必须在a.h 之前进行包含，这在包含顺序上产生了依赖。

1.5总是编写内