《SAC嵌入式软件编程规范》.doc

1概述 编写本规范的目的是为了统一平台软件编程风格，提高软件源程序的可读性、可靠性和可重用性，提高软件源程序的质量和可维护性，减少软件维护成本，最终提高软件产品生产力。 本规范是针对C/C++语言的编程规范，分成规则性和建议性两种：对于规则性规范，要求所有软件开发人员严格执行；对于建议性规范，编程人员可以根据实际情况选择执行。本规范的示例都以C/C++语言描述。 规范的内容包括：基本原则、布局、注释、命名规则、变量常量与类型、表达式与语句、函数与过程、可靠性、可移植性、可测性、断言与错误处理等。规范最后给出了标准模板供软件人员参考。 2范围 本标准规定了C/C++语言的编程规范。 本规范自生效之日起，对以后新编写的和修改的代码有约束力。 3术语 下列术语适用于本标准。 原则 编程时应该坚持的指导思想。 规则 编程时必须遵守的约定。 建议 编程时加以考虑的约定。 说明 对此规则或建议的必要的解释。 正例 对此规则或建议给出的正确例子。 反例 对此规则或建议给出的反面例子。 4基本原则 【原则1】所有的代码尽量遵循ANSI C标准。 说明：所有的代码尽可能遵循ANSI C标准，尽可能不使用ANSI C未定义的或编译器扩展的功能。 【原则2】编程时首先达到正确性，其次考虑效率。 说明：编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，最后才考虑程序的效率和资源占用。 【原则3】避免或少用全局变量。 说明：过多地使用全局变量，会导致模块间的紧耦合，违反模块化的要求。 【原则4】尽量避免使用GOTO语句。 【原则5】尽可能重用、修正老的代码。 说明：尽量选择可借用的代码，对其修改优化以达到自身要求。 5布局 程序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且会涉及到产品质量，涉及到个人编程能力的提高，必须引起大家重视。 文件布局 【规则 1-1-1】遵循统一的布局顺序来书写头文件。 说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。 头文件布局: 文件头（参见“注释”章节） #ifndef 文件名_H（全大写） #define 文件名_H 其它条件编译选项 #include（依次为标准库头文件、非标准库头文件） 常量定义 宏定义 全局数据类型 全局变量 全局函数原型 #endif 【规则1-1-2】遵循统一的布局顺序来书写实现文件。 说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。 实现文件布局： 文件头（参见“注释”章节） #include（依次为标准库头文件、非标准库头文件） 常量定义 文件内部使用的宏 文件内部使用的数据类型 本地变量 局部函数原型 全局函数 局部函数 【规则1-1-3】使用注释块分离上面定义的节。 正例： / ***********************************************************/ /* type define */ /*********************************************************** / typedef unsigned char BOOLEAN; /*************************************************************/ /* function declare */ ************************************************************/ int DoSomething(void); 【规则1-1-4】头文件必须要避免重复包含。 说明：可以通过宏定义来避免重复包含。 正例： #ifndef TEMPLATE_H #define TEMPLATE_H [文件体] #endi