软件工程(2019)结对编程第一次作业
1.审核信息
队友:赵德明
队友代码Coding:结对第一次作业
本人代码Coding:结对第一次作业【由于一些问题,队友的代码上传到了我的仓库里】
2.审核表
该表参考了C++代码审查
功能模块名称 |
链表头部插入数据 |
||
审查人 | 胡博智 | 审查日期 | 2019-4-25 |
代码名称 | 链表头部插入数据 | 代码作者 | 赵德明 |
文件结构 | |||
重要性 | 审查项 | 结论 | |
头文件和定义文件的名称是否合理? | 是 | ||
头文件和定义文件的目录结构是否合理? | 是 | ||
版权和版本声明是否完整? | 无 | ||
重要 | 头文件是否使用了 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)没有正确地关闭文件吗? | 无 | ||
3.复审报告
通过这次的学习,我学会了如何在网页上修改表格的内容并且下载表格的HTML代码,感谢刘文彤同学的帮助。
本次复审的代码为同学的数据结构课设代码,经过了同学多次的修改,代码可以正常运行,页面适合阅读,格式也相对清晰,但是没有详细的注释,,希望队友以后能够有良好的写注释的习惯,代码命名习惯还好,不会出现误读这个代码在功能上实现了应该完成的工作,使用的语法也很基础,调用的多个子函数,并没有将所有都搁置在主函数内。
优点
- 在头文件之前进行注释,介绍代码的功能,让阅读者在阅读代码之前先了解代码的功能,方便了我对代码的理解。
- 代码规范,把各个个功能分别写到几个子函数里,方便阅读。
'{'和'}'独占一行,结构清晰。
缺点
- 代码运行过程中的注释较少,不便于代码的阅读。
定义虽然明了,但是不规范
转载于:https://www.cnblogs.com/Hubz131/p/10762533.html
软件工程(2019)结对编程第一次作业相关推荐
- 软件工程(2018)结对编程第一次作业
软件工程(2018)结对编程第一次作业 本次作业要求对结对编程队友进行一次代码审查. 代码审查表如下 功能模块名称 图的邻接矩阵输出 审查人 李宗健 审查日期 2018/4/6 代码名称 图的邻接矩阵 ...
- 软件工程——结对编程第一次作业
目录 1. 代码地址 2. C/C++代码审查表 3. 代码评价 1. 代码地址 这个项目由王宗波编写,并且已提交至Coding.net系统中,该项目实现的是霍夫曼编码(霍夫曼树)的算法,使用C/C+ ...
- 软件工程综合实践专题第一次作业
软件工程综合实践专题第一次作业 题目:NBA数据库程序分析 来源:SQL SERVER数据库课程同学的小组大作业 create table Coach_information( cname char( ...
- 现代软件工程系列 结对编程 (II) 电梯调度程序
[很多同学完成了上一个结对编程项目后, 很想知道下一个项目是什么, 我们这次要练习如何设计 接口, 测试框架, 和算法] 现代软件工程系列 结对编程 (II) 电梯调度程序 ------- Pai ...
- Unix网络编程---第一次作业
Unix网络编程---第一次作业 要求: 客户端:从命令行读入服务器的IP地址:并连接到服务器: 服务器端: 接受客户的连接请求,并显示客户的IP地址和端口号. 实现代码: 1.客户端程序: ...
- 软件工程课程-结对编程项目
结对编程项目 评分标准 结对编程项目总共8个周时,总分数55分 作业期限每一周算一周时 未按时完成作业,但在作业截止后的3天时间内提交作业的,得作业得分x0.6 作业截止3天后未完成作业,扣该作业总分 ...
- 2022秋软件工程第一次结对编程时作业
软件工程 FZUSDN社区 作业要求 2022秋软件工程第一次结对编程作业 作业目标 使用NABCD进行需求分析并进行原型设计 成员学号 032002217 成员学号 072003403 墨刀链接 墨 ...
- 【现代软件工程】结对编程 —— 四则运算UI
结对作业 -- 用户界面设计 徐楠青 PB16120408 王馨儿 PB16060765 项目简介: 本次结对编程的任务是写一个能自动生成小学四则运算题目并给出答案的软件,分为core组和ui组.我们 ...
- 结对项目—第一次作业(俄罗斯方块)
[项目·俄罗斯方块]需求分析.原型模型 [软件工程实践·结队项目] 第一次作业 Part 0 · 简要目录 Part 1 · 结队信息 Part 2 · NABCD模型 Part 3 · 原型设计 P ...
- 2017282110258--高级软件工程--齐爽爽第一次作业
第一次作业 第一部分:结缘计算机 1.你为什么选择计算机专业?你认为你的条件如何?和这些博主比呢?(必答) 高考之前对自己的未来没有任何规划,也没有想过太多,就看着哪个专业名字顺眼就选的专业,港行当时 ...
最新文章
- 只要5分钟用数据可视化带你看遍11月份新闻热点事件
- KotlinPoet
- SAP Fiori Elements - Account F4 help - how value help dialog is populated
- 使用Mocks进行需求驱动的软件开发
- AVFoundation – AVAssetTrack 获取视频 音频信息
- Rust 1.34.0 发布
- Zookeeper+Kafka集群搭建
- error: Setup script exited with error: Unable to find vcvarsall.bat
- JVM的4种垃圾回收算法、垃圾回收机制与总结
- 如何使用jquery处理json数据
- Colab与谷歌云盘结合使用
- ADSL(中国电信\电信)常见故障代码…
- 左程云 - 大厂刷题班 - 一种字符在左,另一种字符在右的最少交换次数
- dell pc restore 修复计算机,dell 恢复出厂系统 修复计算机选项失效
- linux下.dep文件,Linux 安装 golang 和 dep (附错两个误解决方法)
- 药品市场信息查询-药品数据库(全面)
- T-SQL数据库修改、删除
- 【论文解读】Self-Explaining Structures Improve NLP Models
- 计算机安全在医学中的重要性,试议计算机技术在医学中的意义
- 航空爱好者自问自答(2)
热门文章
- “土地信息+”能否激发千亿大数据应用市场
- 三阶矩阵求特征值的快速算法
- vue+element-admin学习连接
- Springboot中Feign的使用方法
- html5简单拼图游戏,HTML5拼图游戏
- HTTPClient网络异常:java.lang.IllegalStateException: Content has been consumed
- 2、异常值(outliers)检测:业务法、Z-score、3σ准则、箱线图
- 新电脑安装系统时提示 File:\Boot\BCD Status:0xc000000e 错误解决方案
- 仿射变换(Affine Transformation)原理及应用(1)
- el-upload限制文件大小(图片尺寸)