软件工程homework-003
软件工程第三次作业
博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
---|---|
作业要求 | 软件工程第三次作业 |
课程目标 | 熟悉一个“高质量”软件的开发过程 |
作业目标 | 熟悉代码规范及结对互审 |
一、同伴信息
合作伙伴是: 常宇阳 code.
二、审查表
功能模块名称 | |||
审查人 | 戴金池 | 审查日期 | 4.16 |
代码名称 | 检查数据库死锁的等待图法.cpp | 代码作者 | 常宇阳 |
文件结构 | |||
重要性 | 审查项 | 结论 | |
头文件和定义文件的名称是否合理? | 是 | ||
头文件和定义文件的目录结构是否合理? | 是 | ||
版权和版本声明是否完整? | 无 | ||
重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 是 | |
头文件中是否只存放“声明”而不存放“定义” | 是 | ||
程序的版式 | |||
重要性 | 审查项 | 结论 | |
空行是否得体? | 是 | ||
代码行内的空格是否得体? | 是 | ||
长行拆分是否得体? | 是 | ||
“{” 和 “}” 是否各占一行并且对齐于同一列? | 是 | ||
重要 | 一行代码是否只做一件事?如只定义一个变量,只写一条语句。 | 是 | |
重要 | If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 | 是 | |
重要 | 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要? | 是 | |
重要 | 注释是否有错误或者可能导致误解? | 否 | |
重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致? | 无 | |
命名规则 | |||
重要性 | 审查项 | 结论 | |
重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致? | 是 | |
标识符是否直观且可以拼读? | 是 | ||
标识符的长度应当符合“min-length && max-information”原则? | 是 | ||
重要 | 程序中是否出现相同的局部变量和全部变量? | 是 | |
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? | 是 | ||
静态变量、全局变量、类的成员变量是否加前缀? | 否 | ||
表达式与基本语句 | |||
重要性 | 审查项 | 结论 | |
重要 | 如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? | 是 | |
是否编写太复杂或者多用途的复合表达式? | 否 | ||
重要 | 是否将复合表达式与“真正的数学表达式”混淆? | 否 | |
重要 | 是否用隐含错误的方式写if语句? 例如 | ||
(1)将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | ||
(2)将浮点变量用“==”或“!=”与任何数字比较。 | 否 | ||
(3)将指针变量用“==”或“!=”与NULL比较。 | 否 | ||
如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判 | |||
断移到循环体的外面? | 是 | ||
重要 | Case语句的结尾是否忘了加break? | 否 | |
重要 | 是否忘记写switch的default分支? | 否 | |
重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 否 | |
常量 | |||
重要性 | 审查项 | 结论 | |
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? | 是 | ||
在C++ 程序中,是否用const常量取代宏常量? | 是 | ||
重要 | 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? | 否 | |
是否误解了类中的const数据成员?因为const数据成员只在某个对象 | 否 | ||
生存期内是常量,而对于整个类而言却是可变的。 | 否 | ||
函数设计 | |||
重要性 | 审查项 | 结论 | |
参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 | 是 | ||
参数命名、顺序是否合理? | 是 | ||
参数的个数是否太多? | 是 | ||
是否使用类型和数目不确定的参数? | 否 | ||
是否省略了函数返回值的类型? | 是 | ||
函数名字与返回值类型在语义上是否冲突? | 否 | ||
重要 | 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 | 否 | |
重要 | 在函数体的“入口处”,是否用assert对参数的有效性进行检查? | 否 | |
重要 | 使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。 | 否 | |
重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”? | 否 | |
是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need” | 否 | ||
内存管理 | |||
重要性 | 审查项 | 结论 | |
重要 | 用malloc或new申请内存之后,是否立即检查指针值是否为NULL?(防止使用指针值为NULL的内存) | 否 | |
重要 | 是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用) | 否 | |
重要 | 数组或指针的下标是否越界? | 否 | |
重要 | 动态内存的申请与释放是否配对?(防止内存泄漏) | 否 | |
重要 | 是否有效地处理了“内存耗尽”问题? | 否 | |
重要 | 是否修改“指向常量的指针”的内容? | 否 | |
重要 | 是否出现野指针?例如(1)指针变量没有被初始化;(2)用free或delete释放了内存之后,忘记将指针设置为NULL。 | 否 | |
重要 | 是否将malloc/free 和 new/delete 混淆使用? | 否 | |
重要 | malloc语句是否正确无误?例如字节数是否正确?类型转换是否正确? | 无 | |
重要 | 在创建与释放动态对象数组时,new/delete的语句是否正确无误? | 是 | |
C++ 函数的高级特性 | |||
重要性 | 审查项 | 结论 | |
重载函数是否有二义性? | 无 | ||
重要 | 是否混淆了成员函数的重载、覆盖与隐藏? | 无 | |
运算符的重载是否符合制定的编程规范? | 无 | ||
是否滥用内联函数?例如函数体内的代码比较长,函数体内出现循环。 | 无 | ||
重要 | 是否用内联函数取代了宏代码? | 无 | |
类的构造函数、析构函数和赋值函数 | |||
重要性 | 审查项 | 结论 | |
重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数: | ||
(1)缺省的无参数构造函数; | 无 | ||
(2)缺省的拷贝构造函数; | 无 | ||
(3)缺省的析构函数; | 无 | ||
(4)缺省的赋值函数。 | 无 | ||
重要 | 构造函数中是否遗漏了某些初始化工作? | 无 | |
重要 | 是否正确地使用构造函数的初始化表? | 无 | |
重要 | 析构函数中是否遗漏了某些清除工作? | 无 | |
是否错写、错用了拷贝构造函数和赋值函数? | 无 | ||
重要 | 赋值函数一般分四个步骤: | ||
(1)检查自赋值; | 无 | ||
(2)释放原有内存资源; | 无 | ||
(3)分配新的内存资源,并复制内容; | 无 | ||
(4)返回 *this。是否遗漏了重要步骤? | 否 | ||
重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数? | 无 | |
注意事项: | |||
(1)派生类不可能继承基类的构造函数、析构函数、赋值函数。 | 无 | ||
(2)派生类的构造函数应在其初始化表里调用基类的构造函数。 | 无 | ||
(3)基类与派生类的析构函数应该为虚(即加virtual关键字)。 | 无 | ||
(4)在编写派生类的赋值函数时,注意不要忘记对基类的数据成员重新赋值 | 是 | ||
类的高级特性 | |||
重要性 | 审查项 | 结论 | |
重要 | 是否违背了继承和组合的规则? | 无 | |
(1)若在逻辑上B是A的“一种”,并且A的所有功能和属性对B而言都有意义,则允许B继承A的功能和属性。 | 无 | ||
(2)若在逻辑上A是B的“一部分”(a part of),则不允许B从A派生,而是要用A和其它东西组合出B。 | 无 | ||
其它常见问题 | |||
重要性 | 审查项 | 结论 | |
重要 | 数据类型问题: | ||
(1)变量的数据类型有错误吗? | 否 | ||
(2)存在不同数据类型的赋值吗? | 是 | ||
(3)存在不同数据类型的比较吗? | 否 | ||
重要 | 变量值问题: | ||
(1)变量的初始化或缺省值有错误吗? | 否 | ||
(2)变量发生上溢或下溢吗? | 否 | ||
(3)变量的精度够吗? | 是 | ||
重要 | 逻辑判断问题: | ||
(1)由于精度原因导致比较无效吗? | 否 | ||
(2)表达式中的优先级有误吗? | 否 | ||
(3)逻辑判断结果颠倒吗? | 否 | ||
重要 | 循环问题: | ||
(1)循环终止条件不正确吗? | 否 | ||
(2)无法正常终止(死循环)吗? | 否 | ||
(3)错误地修改循环变量吗? | 否 | ||
(4)存在误差累积吗? | 否 | ||
重要 | 错误处理问题: | ||
(1)忘记进行错误处理吗? | 无 | ||
(2)错误处理程序块一直没有机会被运行? | 无 | ||
(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 | 无 | ||
(4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 | 无 | ||
重要 | 文件I/O问题: | ||
(1)对不存在的或者错误的文件进行操作吗? | 否 | ||
(2)文件以不正确的方式打开吗? | 否 | ||
(3)文件结束判断不正确吗? | 否 | ||
(4)没有正确地关闭文件吗? | 否 | ||
三、对同伴代码的评价:
本次审查的代码功能是检查数据库死锁的等待图法。我的搭档常宇阳的代码虽然很长,大部分审查项都有所涉及,但是代码整体比较完备和规范。
优点:
(1)代码的整体结构十分清晰,各个函数都分工规范明确,设计得当。
(2)添加的注释简介明了,代码的可读性非常好。
(3)代码排版合理清晰,()和{}的搭配恰当。
缺点:
(1)界面设计上还是不够友好,非专业人士难以上手。
(2)没有错误处理函数,在出现异常或者错误时不能有反馈。
(3)个别函数里有一些变量名不合理,一些代码的功能没有注释。
总结:此程序一共395行,整体比较整洁,结构比较严谨,逻辑清晰,具有相当的可读性,通过这次审查,我了解到了许多修改,调试,完善自己代码的方法,对以后的学习工作生活帮助很大。经过对代码的阅读、运行及审查,我觉得我搭档的代码写的很好,整体结构清晰,排版合理,给人感觉十分工整,代码的完备性很高,运行流畅。此外,代码中注释的标注也十分详细得当,做到了覆盖重点,同时也不杂乱,可以让读者很容易理解各模块的作用,代码的可读性很高。建议他今后可以根据实际需求改进程序输入的方式,将界面和输入设计得更合理舒适些,这样编写的程序会更好。最后希望在今后的结对合作中,我们可以相互学习彼此的优点,互相进步,共同提升!
软件工程homework-003的更多相关文章
- Team Homework #3 软件工程在北航——IloveSE
任务要求: 采访以前上过北航 (计算机系/软件学院) 软件工程课的同学.现在上研/工作的也可以. 采访问题如下:* 平均每周花在这门课上的时间 (包括上课/作业/上机) * 平均写的代码总行数 ...
- 团队博客作业Week1 Team Homework #3软件工程在北航
这次我们采访了一位大四的学姐,让她简单地谈了谈去年学习软件工程的经历和感受. 在完成软件工程大作业的过程中,由于计划安排与实际脱节,导致时间前松后紧,平均每周花在这门课上的时间大约有8个小时. 项目完 ...
- Week1 Team Homework #3: 软件工程在北航
在组内成员的共同努力,我们采访了几个学长学姐,顺利完成任务.反馈信息如下: 平均每周花在这门课上的时间 平均写的代码总行数 学到的最有用的部分 最没用的部分 <软件工程>最应该改进的地方 ...
- 软件工程first homework
1) 2017*****7193:我是最乐观的刘新飞:我的爱好是下中国象棋和听音乐: 我的码云个人主页是码云个人主页: 我的第一个项目地址是×××: 自己目前的代码量是三千行左右:我最喜欢蛋肠炒面(一 ...
- 软件工程导论九月26号Homework
习题3 (1)数据流图 (2)实体关系图ER 习题6
- 软件工程 week 05
关于 石墨文档客户端 的案例分析 作业地址:https://edu.cnblogs.com/campus/nenu/2016CS/homework/2505 一.调研测评 测试平台:Windows 1 ...
- 软件工程第四次作业 石墨文档IOS
待分析的产品:石墨文档IOS客户端 作业地址: https://edu.cnblogs.com/campus/nenu/2016CS/homework/2505 第一部分 调研, 评测 1.下载并 ...
- 软件工程 week 04
四则运算 一.摘要 作业地址:https://edu.cnblogs.com/campus/nenu/2016CS/homework/2266 git仓库地址:https://git.coding.n ...
- 软件工程启程篇章:结对编程和进阶四则运算(197 & 199)
0x01 :序言:无关的事 I wrote a sign called "Dead End" in front of myself, but love crossed it wit ...
- 【软件工程Ⅱ】作业二 |分布式版本控制系统Git的安装与使用
本次作业的要去来自于:https://edu.cnblogs.com/campus/gzcc/GZCC-16SE2/homework/2097 远程库地址:https://github.com/Mol ...
随机推荐
- python基础篇-爬虫urlparse使用及简单示例
>>> from urllib.parse import urlparse >>> o = urlparse('http://www.cwi.nl:80/%7Egu ...
- 测试前期API未实现时,如何写测试方法
大家在做接口测试的时候可能经历过这种情况,开发出来接口文档后,测试人员就要开始编写接口测试的自动化代码.这时就会用到了mock server,mock server不在这里说了,百度一大堆,想怎么实现 ...
- win8.1/2012R2上面安装flash debugger
1.开启windows桌面体验 a. Launch Power Shell b. Run command "add-WindowsFeature Desktop-Experience&quo ...
- HDOJ acm steps 3.1.1
(都是递推求值,呵呵,好开心- - ) 今天又是在自习室通宵(文明玩的停不下来了) 游戏玩完想想该水题了,于是打开了HDOJ的ACM STEPS(这是个好东西,就像他的名字,一步步来的) 2.3.x貌 ...
- Hibernate与JDBC事务整合
一般大家都会使用Spring声明型事务 transactionAttributes 为 PROPAGATION_REQUIRED Hibernate 使用 HibernateTransactionMa ...
- Shell之awk
Shell之awk 目录 Shell之awk 一.awk概述 1. awk的工作原理 2. 命令格式 3. awk常见的内建变量(可直接用) 二.操作实例 1. 按行输出文本 2. 按字段输出文本 3 ...
- C#后台去除HTML标签
public string NoHTML(string Htmlstring) { //删除脚本 Htmlstring = Regex.Replace(Htmlstring, @"<s ...
- docker基础——4.网络待补
docker network ls bridge:NAT桥 host:共用宿主机namespace的UTS.IPC.Network none:只有lo,没有网卡 其他待补
- MySQL语法命令之约束篇
文章目录 1.约束概述 1.1约束的分类 1.2添加约束 2.查看表中的约束 3. `not null` 非空约束 3.1 在 `create table` 时创建 3.2 在`alter table ...
- spring boot 配置静态路径
一 前言 最近有个项目,需要上传一个zip文件(zip文件就是一堆的html压缩组成)的压缩文件,然后后端解压出来,用户可以预览上传好的文件. 查看资料,spring boot对静态文件,可以通过配 ...