GJB5000A2008全套资料002-研发部CC++程序编码规范.doc

PAGE 2 C/C++程序编码规范 BBTNL.COM有限责任公司 研发部 二〇一一年一月 系统（设备） 名 称 文 件 号 文 件 名 称 C/C++程序编码规范 共 NUMPAGES 59页 序号 更改标记 数量 更改通知单号 签 名 日 期 备 注 编制 会签 审核 标检 批准 历史修改记录： 日 期 版本 说 明 编制/修改人 2007-1-15 V0.1 初稿编制完成。 BBTNL 2007-1-30 V1.0 软件组讨论通过，并正式发布实施。 BBTNL 2011-1-20 V1.1 修改为公司研发部规范 BBTNL PAGE 19 前 言 软件编程规范的目的是为了统一软件编程风格，提高软件源程序的可读性、可靠性和可重用性，提高软件源程序的质量和可维护性，减少软件维护成本，最终提高软件产品生产力。 本规范是针对C/C++语言的编程规则，其它不同编程语言可以参照此规范执行。本规范适用于本研究室所有产品的软件源程序，同时考虑到不同产品和项目的实际开发特性，本规范分成规则性和建议性两种：对于规则性规范，要求所有软件开发人员严格执行；对于建议性规范，各项目编程人员可以根据实际情况选择执行。本规范的示例都以C/C++语言描述。 本规范的内容包括：基本原则、文件结构、程序的版式、注释、命名规则、变量常量与类型、表达式和语句、函数设计、可靠性、可测试性等。规范最后给出了标准模板供软件人员参考。 本规范自生效日期起，对以后新编写的和修改的代码有约束力。对以前的代码不要求进行修改。对于由开发工具自动生成的代码可以不约束。 对本规范中所使用的术语解释如下： 原则：编程时应该坚持的指导思想。 规则：编程时必须遵守的约定。 建议：编程时必须加以考虑的约定。 说明：对此规则或建议的必要的解释。 正例：对此规则或建议给出的正确例子。 反例：对此规则或建议给出的反面例子。 AAA电子 研发部 2011年01月 目 录 TOC \o 1-5 \h \z \u 前 言 1 目 录 1 第一章 基本原则 1 第二章 文件结构 2 2.1 版权和版本的声明 2 2.2 头文件的结构 2 2.3 定义文件的结构 3 2.4 文件结构的规则和建议 3 第三章 程序的版式 5 3.1 空行 5 3.2 代码行 6 3.3 代码行内的空格 6 3.4 对齐 8 3.5 长行拆分 9 3.6 修饰符的位置 10 3.7 预处理命令 10 第四章 注释 12 第五章 命名规则 15 第六章 变量、常量与类型 20 6.1 变量与常量 20 6.2 类型 23 第七章 表达式和语句 28 7.1 运算符的优先级 28 7.2 操作符 29 7.3 复合表达式 29 7.4 if 语句 30 7.5 循环语句的效率 33 7.6 for 语句的循环控制变量 34 7.7 switch语句 34 7.8 while语句 36 7.9 goto语句 36 第八章 函数设计 37 8.1 参数 37 8.2 返回值 38 8.3 函数内部实现的规则 40 8.4 函数调用 43 第九章 可靠性 46 9.1 内存管理 46 9.2 指针的使用 47 9.3 函数 48 第十章 可测试性 49 附 录 52 附录A 头文件模版（规范性模版） 52 附录B 实现文件模版（规范性模版） 52 参考文献 53 凌久电子研发部 C/C+程序编码规范 第一章 基本原则 【原则1-1】首先是为人编写程序，其次才是计算机。 说明： 这是软件开发的基本要点，软件的生命周期贯穿产品的开发、测试、生产、用户使用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力。 【原则1-2】保持代码的简明清晰，避免过分的编程技巧。 说明： 简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则会降低程序的可读性。 【原则1-3】所有的代码尽量遵循ANSI C标准。 说明： 所有的代码尽可能遵循ANSI C标准，尽可能不使用ANSI C未定义的或编译器扩展的功能。 【原则1-4】编程时首先达到正确性，其次考虑效率。 说明： 编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，最后才考虑程序的效率和资源占用。 【原则1-5】避免或少用全局变量。 说明： 过多地使用全局变量，会导致模块间的紧耦合，违反模块化的要求。 【原则1-6】尽量避免使用GOTO语句。 【原则1-7】尽可能复用、修正老的代码。 说明： 尽量选择可借用的代码，对其修改优化以达到自身要求。 【原则1-8】 尽量减少同样的错误出现