作业公共信息区
| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
1.题目要求
首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求；
从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
将代码上传至个人GitHub系统中，并将代码地址交给对方；
对同伴的作品进行代码复审，并参照 C/C++代码审查表和 Java代码审查表这两篇博文的内容将检查内容填入一下代码审查表中；
将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub代码地址；
对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
2.结对编程
本次结对编程，我的结队队友是冯澳，他的代码任务是通讯录处理系统，下面是我伙伴的代码：
[通讯录处理系统](https://github.com/fafa3232/-/blob/master/通讯录处理系统
）
3.代码复审
| 功能模块名称 | 通讯录处理系统 | ||
|---|---|---|---|
| 审查人 | 代亨兰 | 审查日期 | 2020/4/15 |
| 代码名称 | 通讯录处理系统 | 代码作者 | 冯澳 |
| 文件结构 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 头文件和定义文件的名称是否合理？ | 是 | |
| 2 | 头文件和定义文件的目录结构是否合理？ | 是 | |
| 3 | 版权和版本声明是否完整？ | 否 | |
| 4 | 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 否 |
| 5 | 头文件中是否只存放“声明”而不存放“定义” | 是 | |
| 程序的版式 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 6 | 空行是否得体？ | 是 | |
| 7 | 代码行内的空格是否得体？ | 是 | |
| 8 | 长行拆分是否得体？ | 是 | |
| 9 | “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 | |
| 10 | 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 |
| 11 | 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 否 |
| 12 | 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 |
| 13 | 重要 | 注释是否有错误或者可能导致误解？ | 否 |
| 14 | 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 无 |
| 命名规则 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 15 | 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 |
| 16 | 标识符是否直观且可以拼读？ | 是 | |
| 17 | 标识符的长度应当符合“min-length && max-information”原则？ | 是 | |
| 18 | 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 |
| 19 | 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | |
| 20 | 静态变量、全局变量、类的成员变量是否加前缀？ | 否 | |
| 表达式与基本语句 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 21 | 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 |
| 22 | 是否编写太复杂或者多用途的复合表达式？ | 否 | |
| 23 | 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 |
| 24 | 重要 | 是否用隐含错误的方式写if语句? 例如 | |
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 25 | 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？ | 否 | |
| 26 | 重要 | Case语句的结尾是否忘了加break？ | 否 |
| 27 | 重要 | 是否忘记写switch的default分支？ | 否 |
| 28 | 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 否 |
| 函数设计 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 29 | 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 否 | |
| 30 | 参数命名、顺序是否合理？ | 是 | |
| 31 | 参数的个数是否太多？ | 否 | |
| 32 | 是否使用类型和数目不确定的参数？ | 否 | |
| 33 | 是否省略了函数返回值的类型？ | 否 | |
| 34 | 函数名字与返回值类型在语义上是否冲突？ | 否 | |
| 35 | 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 |
| 36 | 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 无 |
| 37 | 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 无 |
| 38 | 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 是 |
| 39 | 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | |
| 内存管理 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 40 | 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 是 |
| 41 | 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 否 |
| 42 | 重要 | 数组或指针的下标是否越界？ | 否 |
| 43 | 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 是 |
| 44 | 重要 | 是否有效地处理了“内存耗尽”问题？ | 否 |
| 45 | 重要 | 是否修改“指向常量的指针”的内容？ | 是 |
| 46 | 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 否 |
| 47 | 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 否 |
| 48 | 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 是 |
| 49 | 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 是 |
| C++ 函数的高级特性 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 50 | 重载函数是否有二义性？ | 否 | |
| 51 | 重要 | 是否混淆了成员函数的重载、覆盖与隐藏？ | 否 |
| 52 | 运算符的重载是否符合制定的编程规范？ | 否 | |
| 53 | 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 | 否 | |
| 54 | 重要 | 是否用内联函数取代了宏代码？ | 否 |
| 类的构造函数、析构函数和赋值函数 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 55 | 重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数： | |
| （1）缺省的无参数构造函数； | 否 | ||
| （2）缺省的拷贝构造函数； | 否 | ||
| （3）缺省的析构函数； | 否 | ||
| （4）缺省的赋值函数。 | 否 | ||
| 56 | 重要 | 构造函数中是否遗漏了某些初始化工作？ | 否 |
| 57 | 重要 | 是否正确地使用构造函数的初始化表？ | 否 |
| 58 | 重要 | 析构函数中是否遗漏了某些清除工作？ | 否 |
| 59 | 是否错写、错用了拷贝构造函数和赋值函数？ | 否 | |
| 60 | 重要 | 赋值函数一般分四个步骤： | |
| （1）检查自赋值； | 否 | ||
| （2）释放原有内存资源； | 否 | ||
| （3）分配新的内存资源，并复制内容； | 否 | ||
| （4）返回 *this。是否遗漏了重要步骤？ | 否 | ||
| 61 | 重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数？ | 是 |
| 注意事项： | |||
| （1）派生类不可能继承基类的构造函数、析构函数、赋值函数。 | 否 | ||
| （2）派生类的构造函数应在其初始化表里调用基类的构造函数。 | 否 | ||
| （3）基类与派生类的析构函数应该为虚（即加virtual关键字）。 | 无 | ||
| （4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值 | 否 | ||
| 类的高级特性 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 62 | 重要 | 是否违背了继承和组合的规则？ | 否 |
| （1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。 | 否 | ||
| （2）若在逻辑上A是B的“一部分”（a part of），则不允许B从A派生，而是要用A和其它东西组合出B。 | 否 | ||
| 其它常见问题 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 63 | 重要 | 数据类型问题： | |
| （１）变量的数据类型有错误吗？ | 否 | ||
| （２）存在不同数据类型的赋值吗？ | 是 | ||
| （３）存在不同数据类型的比较吗？ | 否 | ||
| 64 | 重要 | 变量值问题： | |
| （１）变量的初始化或缺省值有错误吗？ | 否 | ||
| （２）变量发生上溢或下溢吗？ | 否 | ||
| （３）变量的精度够吗？ | 是 | ||
| 65 | 重要 | 逻辑判断问题： | |
| （１）由于精度原因导致比较无效吗？ | 否 | ||
| （２）表达式中的优先级有误吗？ | 否 | ||
| （３）逻辑判断结果颠倒吗？ | 否 | ||
| 66 | 重要 | 循环问题： | |
| （１）循环终止条件不正确吗？ | 否 | ||
| （２）无法正常终止（死循环）吗？ | 否 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 否 | ||
| 67 | 重要 | 错误处理问题： | |
| （１）忘记进行错误处理吗？ | 否 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 否 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 否 | ||
| 68 | 重要 | 文件I/O问题： | |
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | ||
| （２）文件以不正确的方式打开吗？ | 否 | ||
| （３）文件结束判断不正确吗？ | 否 | ||
| （４）没有正确地关闭文件吗? | 是 |
4.对同伴的代码评论，介绍同伴的优缺点。
通过这次结对作业，看了我伙伴的代码，然后对于伙伴的优缺点我进行了总结，首先我说说他的优点，然后再说说他的缺点：
优点1：代码层次分明，通俗易懂。他的代码中结构体定义，文件输入，菜单，输入，显示，修改，查找，添加，删除，还有主函数都是单独敲的，
给别人复审可以马上了解他的这个代码所要实现的功能，一下子就可以明白他所表达的意思。
优点2：他的数据的输入使用了链表指针，我们在数据结构里学习到，链表指针的存储是动态存储，
其优点在于数据需要一个空间，我们就创建一个空间，这样就不会造成存储资源的浪费，而如果用数组固定分配的话就会浪费空间。
优点3：他使用了文件的知识，在读取数据的时候也开辟了一个文件，这样输入一个数据就会自动备份到文件中，
之后我们要执行，添加，修改，删除操作时就不会担心数据的丢失，直接找到文件夹复制过来数据就可以再用了。
如果有几十万的数据或者更多的数据要输入，有一个文件夹是一个方便快捷的方式。
优点4：使用了C++中的输入cin和输出cout,使用这两个输入输出比scanf和printf要好，因为后者必须得指定数据是怎样的类型，
而前者就不用那么麻烦。
优点5：在定义结构体时，每一个数据的字符类型考虑得很周到，并且长度也先前进行了估计，这样就不会浪费空间，他的结构体定义如下：
struct txl //建立关于通讯录的结构体
{
char num[10];
char name[30];
char sex[5];
int age;
char tnumber[15]; //电话号
char jiguan[50];
char gzdanwei[50]; //工作单位
char home[50];
char txdizhi[50];
int youbian;
struct txl* next;
};
缺点：在创建链表指针完成后，未进行对空间的释放。