编程规范讲义(胡绍平).ppt

2002.11.30 编程规范的作用 提高源程序的可读性和可维护性 降低错误的机会 提高源代码可重用性和质量 规范的三种形式 原则：编程时应该坚持的指导思想。 规则：编程时必须遵守的约定。 建议：编程时必须加以考虑的约定。 规范的内容 1 基本原则 2 布 局 3 注 释 4 命名规则 5 变量、常量与类型 6 表达式与语句 7 函数与过程 8 可靠性 9 可测试性 10 断言与错误处理 基本原则 【原则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（依次为标准库头文件、非标准库头文件） 常量定义 文件内部使用的宏 文件内部使用的数据类型 全局变量 本地变量（即静态全局变量） 局部函数原型 类的实现 全局函数 局部函数 布局 【规则2-1-3】使用注释块分离上面定义的节。 / *********************************************************** * 数据类型定义 * *********************************************************** / typedef unsigned char BOOLEAN; ? /************************************************************* * 函数原型 * ************************************************************/ int DoSomething(void); 布局 【规则2-1-4】头文件必须要避免重复包含。 #ifndef MODULE_H #define MODULE_H [文件体] #endif 布局 【规则2-1-5】包含标准库头文件用尖括号 ，包含非标准库头文件用双引号 “ ”。 #include stdio.h #include “heads.h” 布局 【规则2-1-6】遵循统一的顺序书写类的定义及实现。 类的定义（在定义文件中）按如下顺序书写： 公有属性， 公有函数， 保护属性， 保护函数 私有属性， 私有函数 类的实现（在实现文件中）按如下顺序书写： 构造函数，析构函数 公有函数 保护函数 私有函数 布局 【规则2-2-1】程序中一行的代码和注释不能超过80列。 包括空格在内不超过80列。 布局 【规则2-2-2】if、else、else if、for、while、do等语句自占一行，执行语句