嵌入式软件编程开发规范及条件

关于编程规范及原则

　　编程规范也就是编写出简洁、可维护、可靠、可测试、高效、可移植的代码，提高产品代码的质量。

　　本文针对嵌入式，主要结合C语言编程的规范给大家讲述。

　　1.头文件

　　对于C语言来说，头文件的设计体现了大部分的系统设计，不合理的头文件布局是编译时间过长的原因。

　　有很多人将工程中所有的头文件包含在一个include.h文件中，然后在每一个.c源代码文件中包含include.h头文件，这样做可以让代码看上去简洁，但实际忽视了编译效率问题，而且代码的可移植性也不好。

　　原则：

　　A.头文件中适合放置接口的声明，不适合放置实现;

　　B.头文件应当职责单一;

　　C.头文件应向稳定的方向包含。

　　规则：

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

　　B.禁止头文件循环依赖;

　　C..c/.h文件禁止包含用不到的头文件;

　　D.头文件应当自包含;

　　E.总是编写内部#include保护符( #define 保护);

　　F.禁止在头文件中定义变量;

　　G.只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c中通过extern的方式使用外部函数接口、变量;

　　H.禁止在extern "C"中包含头文件。

　　建议：

　　A.一个模块通常包含多个.c文件，建议放在同一个目录下，目录名即为模块名。为方便外部使用者，建议每一个模块提供一个.h，文件名为目录名;

　　B.如果一个模块包含多个子模块，则建议每一个子模块提供一个对外的.h，文件名为子模块名(降低接口使用者的编写难度);

　　C.头文件不要使用非习惯用法的扩展名，如.inc;

　　D.同一产品统一包含头文件排列方式。

　　2.函数

　　函数设计的要点：编写整洁的函数，同时把代码有效组织起来。

　　函数整洁的要求：代码简单直接、不隐藏设计者的意图、用干净利落的抽象和直截了当的控制语句将函数有机组织起来。

　　原则：

（编辑：常州站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!