嵌入式软件编程书写规范

《嵌入式软件编程书写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、嵌入式软件编程书写规范嵌入式软件编程书写规范文档号：版本：V1.00撰写：R.Y.日期：2011-04-14单位：审阅：日期：单位：声明：该文档为作者从其它公共文档和个人经验中总结的，仅供参考，欢迎查阅和修改。-1-嵌入式软件编程书写规范修改记录VersionDateByDescription1.002011.1.24R.Y.createdocument-2-嵌入式软件编程书写规范目录一、规范原则．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．4二、代码布局．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．5基本布局．．．．

2、．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．5对齐．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．7空行空格．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．9断行．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．10三、注释．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．11四、命名规则．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．12五、变量、常量、宏定义与类型．．．．．．．．．．．．．．．．．．．．．．．

3、．．．15六、表达式与语句．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．18七、函数与过程．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．20参数．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．20返回值．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．21内部实现．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．21函数调用．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．22八、可靠性．．．．．．．．．．．．．．．．．．．．．．

4、．．．．．．．．．．．．．．．．．．．．．．23九、可测试性．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．25十、断言与错误处理．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．26附录A编程模板．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．27附录B规范检查表．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．．32-3-嵌入式软件编程书写规范本规范适用于嵌入式C/C++语言。下列规范包括有规范，建议，说明，例子。一、规范原则原则一：避免使用特殊编程技巧，保持代码简单清晰。说明：软

5、件单次使用周期短，贯穿设计，测试，生产，售后，版本升级等环节，因此需具有较强可读性，可维护性。原则二：模块化编程，少用甚至不用全局变量，GOTO语句。说明：模块化有利于增强程序的正确性，可维护性，移植性。全局变量和GOTO语句则违反了模块化的原则，因此避免使用。原则三：尽量调用库文件，修改老版本代码，完善代码质量。说明：对于模块化程序，因为相对单一功能的程序都是模块化的，所以对于功能整合的程序来说，避免浪费时间去重写单一功能的代码，尽量调用库文件；对于版本较老的，尽量完善老版本，提高质量。-4-嵌入式软件编程书写规范二、代码布局代码布局可体现代码的逻辑结构，关系到代码的可读性，正确性，可维护性

6、，连续性。更重要的是，统一的代码布局，有利于提高整个软件开发团队的开发速度，有利于提高软件开发质量。对于个人则体现出个人编程修养。说明：以下内容某些节若不需要，可以忽略，但其他节应保持次序。基本布局【规范２-1】：头文件的统一布局格式。#ifndef_文件名_H（全大写）#define_文件名_H（全大写）其它条件编译选项#include（依次为标准库头文件，非标准库文件）全局常量声明全局宏声明全局数据类型声明全局变量声明全局函数原型声明类定义[c++]模板（template，包括类模板和函数模板）[c++]#endif/*_文件名_H*/注意事项：1、头文件通过宏定义来避免重复包含2、包含

7、标准库头文件用尖括号<>，包含非标准库头文件用双引号””。-5-嵌入式软件编程书写规范【规范2-2】：源文件的统一布局格式。#include（依次为标准库头文件，非标准库文件）文件内部常量定义文件内部宏定义文件内部数据类型定义文件内部本地变量定义（静态全局变量）函数原型定义类的实现[c++]【规范2-3】：类的定义及实现的统一布局格式。类的定义（在定义文件中）按如下顺序书写：公有属性公有函数保护属