软件实现

代码检查清单
代码检查：属性
－类该属性是否必要？ －能否是静态的（static）？ －应该是 final 吗？ －是否正确地应用了命名约定？ －是否尽量地私有（private）？ －属性之间是尽可能地独立吗？
－初始化策略是否可理解？
说明时初始化？使用构造函数初始化？使用静态 块 static{ }？ 混合使用上述方法？如何初始化？
程序的版式
匈牙利命名法
变量名 ＝ 前缀 ＋ 每个单词首字母大写 前缀表示数据类型，全部小写 int float char char iMaxIndex; fNewValue; szBuffer[100]; *lpszFileName = szBuffer;
程序的版式
匈牙利命名法
成员变量名前加 m_ 全局变量名前加 g_ 静态变量名前加 s_
内存泄漏问题
指针参数问题
“野指针”问题
内存异常问题
“野指针”问题
char *p = (char *)malloc(100); strcpy(p, “hello”); free(p); … if(p != NULL) { strcpy(p, “world”); }
char *p = (char *)malloc(100); strcpy(p, “hello”); free(p); p = NULL; … if(p != NULL) { strcpy(p, “world”); }
标识符应直观、好读、可顾名思义 标识符长度应当“长度简短、含义丰富” 命名规则尽量与所采用的操作系统、开发工具 、开发团队的风格保持一致
程序的版式
命名规则
变量名应使用“名词”或“形容词＋名词” 全局函数的名字应当使用“动词”或者“动词 ＋名词” 类的成员函数应当只使用“动词”，被省略掉 的名词就是对象本身
程序的版式
匈牙利命名法
常量全部大写，用下划线分隔 #define MAX_LENGTH 100 函数名/类名 = 每个单词首字母大写 class LeafNode; void SetValue(int iValue);
主要内容
正确理解软件编码
－软件编码的含义
－程序员应具备的能力
软件编码规范 软件代码检查
编码过程与文档流
主Hale Waihona Puke 内容正确理解软件编码－软件编码的含义
－程序员应具备的能力
软件编码规范 软件代码检查
－错误的类型 －代码检查清单
程序复杂性的度量
代码行度量法 McCabe度量法
软件编码规范
源文件结构
程序的版式
源文件结构
C / C++源程序的组织
头文件
用于保存程序的声明 后缀：.h
定义文件
用于保存程序的实现 后缀：.c / .cpp / .cc
－软件编码是将软件设计模型机械地转换 成源程序代码，这是一种低水平的、缺乏创 造性的工作
－软件程序员是所谓的“软件蓝领”
问题
－你是否认同这种观点？ －如果不认同，你如何看待软件编码？
什么是软件编码
Professional Programmer = Software Engineer
正确观点
－软件编码是一个复杂而迭代的过程，包括程序 设计和程序实现
采用比较交换法和选择法对上述10个数据进 行排序，然后分别对这两种方法进行比较，并从
程序的运行效率角度对两个程序进行比较。
main() { int a[10], i, j, t; for(i=0; i<10; i ++) scanf(“%d”, &a[i]); for(i=0; i<9; i ++) for(j=i+1; j<10; j++) if(a[j] < a[i]) { t = a[j]; a[j] = a[i]; a[i] = t; } for(i=0;i<10;i++) printf(“%2d”, a[i]);
－错误的类型 －代码检查清单
程序复杂性的度量
代码行度量法 McCabe度量法
错误严重性
问题
编译没有错误是否说明程序没有错误？ 如何发现程序中的逻辑错误或语义错误？
严重性是代码检查的基本特性，通过其分类可 以划定错误的优先顺序，以便理性地调度工作 错误的严重性
严重的：需求没有满足
很小的：不影响运行和维护 中等的：除了以上两种情况
源文件结构
定义文件的结构
定义文件的结构
版权和版本声明 对一些头文件的引用 程序的实现体（包括数据和代码）
程序的版式
对比以下两段程序的排版
程序的版式
程序的版式
空行
类定义之间、函数之间、函数内部不同段落之 间应该加空行分割
程序的版式
代码行
一行代码只做一件事情，如只定义一个变量， 只写一条语句
程序的版式
－不正确的数据初始化；不正确的数据访问或数据存 储；不正确的数据标量值或单位；不正确的数据维数
不正确的数据范围
－不充分的或不正确的等式表达式；精确性的损失； 符号约定等错误
数据问题
－不正确或缺少敏感数据；不正确或缺少操作数据； 不正确或缺少表中的嵌入数据；不正确或缺少外部数据 ；不正确或缺少输出数据；不正确或缺少输入数据
－参数类型是否受限？
代码检查清单
代码检查：方法体
－算法是否与设计伪码或流程图相符？ －代码假设只有前置条件吗？ －代码是否产生了每一个后置条件？ －代码是否遵守了所要求的不变式？ －是否每一个循环都能够终止？ －是否遵循了所要求的符号标准？
－是否每一行都进行了彻底检查？
－所有括号是否匹配？ －是否考虑了所有非法参数？ －代码是否返回了正确的类型？ －代码是否被清楚地注释？
－是否尽量地私有（private）？
代码检查清单
代码检查：方法头(续)
－能否是静态的（static）？ －应该是 final 吗？ －方法的头部是否描述了该方法的目的？ －方法的头部是否引用了该方法满足的需求或设计部分？ －是否说明了所有必要的变量？
－是否说明了所有的前置条件？
－是否说明了所有的后置条件？ －是否应用了文档标准？
例3: 内存异常问题
总结
－非法内存访问的基本特征是代码访问了不该访问的内存
地址
－某些“自由的”语言更容易引发内存错误(如C/C++) －要避免产品中出现内存错误，好的编码规范、所选的语
言和工具、有效的测试等工作都是有意义的
例3: 内存异常问题
内存的分配方式
－从静态存储区域分配
内存在编译时已分配好，在程序的整个运行期间都存在。例
源文件结构
版权和版本的声明
位于头文件和定义文件的开头 内容
版权信息 文件名称、标识符、摘要 当前版本号、作者/修改者、完成日期 版本历史信息
源文件结构
头文件的结构
头文件的结构
版权和版本声明 预处理块 函数和类结构声明等
源文件结构
头文件的结构
规则
用#include <filename.h>格式来引用标准库 的头文件（编译器将从标准库目录开始搜索）
－软件编码要求

正确地理解用户需求和软件设计思想 正确地根据设计模型进行程序设计 正确而高效率地编写和测试源代码
－软件编码是设计的继续，会影响软件质量和可 维护性
软件实现的过程
代码设计 设计审查 代码编写 代码走查
代码编译
单元测试
软件编码的工作
程序设计
－理解软件的需求说明和设计模型
－补充遗漏的或剩余的详细设计
如：全局变量、静态变量等。
－在堆栈上创建
在函数执行期间，函数内的局部变量(包括形参)的存储单元 都创建在堆栈上，函数结束时这些存储单元自动释放（堆栈清退 ）
－从堆（heap）上分配，也称动态内存分配
程序运行期间用 malloc 或 new 申请任意数量的内存，程序 员自己掌握释放内存的恰当时机（使用free或delete）
第七章 软件实现
软件实现的过程
代码设计 设计审查 代码编写 代码走查
代码编译
单元测试
主要内容
正确理解软件编码
－软件编码的含义
－程序员应具备的能力
软件编码规范 软件代码检查
－错误的类型 －代码检查清单
程序复杂性的度量
代码行度量法 McCabe度量法
什么是软件编码
Programming ? Coding = 一种观点
代码检查清单
代码检查：构造函数
－该构造函数是否必要？使用工厂方法是否更合适？
－是否平衡已有的构造函数？（一种Java 仅有的能力）
－是否将所有的属性进行了初始化？ －是否尽量地私有（private）？ －必要时，是否执行了继承的构造函数？
代码检查：方法头
－该方法是否被适当地命名？是否与需求或设计一致？
－使用z打头的变量名、函数名、宏定义名就像是为自己
的旅行箱贴标签 －将void，int，float等基本数据类型重新命名，可以在
最大程度上保证代码的可移植性
－使用宏定义表示一些基本的功能运算可以大幅度减少源 程序的行数，也可以被后者方便地复用
－使用高度简练的缩写可以加强源代码的保密程度
例3: 内存异常问题
例1: 程序注释
程序注释的原则
－注释应当浅显、明白 －注释不是程序员指南 －注释不是标准库函数参考手册 －注释的主要任务是答疑解惑而不是增加程序的行数 －好的注释是对设计思想的精确表述和清晰展现
问题：
－例1的程序注释存在什么问题？ －按照上述原则，如何修改例1的程序注释？
例2: 程序变量命名
例2所示的程序风格如何？你能够容易理解吗？ 编程人员的理由