项目管理文档7-软件编程规范.docVIP

硬件开发部 软件编程规范 — C/C++ 发布 实施  目 次 前 言 II 1 范围 1 2 术语和定义 1 2.1 原则 1 2.2 规则 1 2.3 建议 1 2.4 说明 1 2.5 正例 1 2.6 反例 1 3 基本原则 1 4 布局 2 4.1 文件布局 2 4.2 基本格式 5 4.3 对齐 6 4.4 空行空格 8 4.5 断行 9 5 注 释 10 6 命名规则 15 前 言 编写本标准的目的是为了统一硬件开发部软件编程风格，提高软件源程序的可读性、可靠性和可重用性，提高软件源程序的质量和可维护性，减少软件维护成本，最终提高软件产品生产力。 本规范是针对C/C++语言的编程规范，其它不同编程语言可以参照此规范执行。本规范适用于硬件开发部所有产品的软件源程序，同时考虑到不同产品和项目的实际开发特性，本规范分成规则性和建议性两种：对于规则性规范，要求所有软件开发人员严格执行；对于建议性规范，各项目编程人员可以根据实际情况选择执行。本规范的示例都以C/C++语言描述。 本规范的内容包括：基本原则、布局、注释、命名规则等。 自本标准实施之日起，以后新编写的和修改的代码均应执行本标准。 本标准由硬件开发部提出。 本标准起草部门：开发部。 本标准于2010年5月首次发布。   范围 本标准规定了C/C++语言的编程规范。 本标准适用于部门内使用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】 尽量减少同样的错误出现的次数。 说明：事实上，我们无法做到完全消除错误，但通过不懈的努力，可以减少同样的错误出现的次数。 布局 程序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且会涉及到产品质量，涉及到个人编程能力的提高，必须引起大家重视。 文件布局 【规则2-1-1】遵循统一的布局顺序来书写头文件。 说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。 头文件布局: 文件头（参见第三章“注释”） #ifndef 文件名_H（全大写） #define 文件名_H 其它条件编译选项 #include（依次为标准库头文件、非标准库头文件） 常量定义 全局宏 全局数据类型 类定义 模板（template）（包括C++中的类模板和函数模板） 全局函数原型 #endif 【规则2-1-2】遵循统一的布局顺序来书写实现文件。 说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。 实现文件布局： 文件头（参见第三章“注释”） #include（依次为标准库头文件、非标准库头文件） 常量定义 文件内部