软件工程第一次作业（结对作业）
代码复审
1.问题描述
(1). 首先在同学中找一个同伴，范围不限，可以在1~5班中随意组合，建议尽量不要找同组的成员，女同学尽量找男同学结对，但是不做强制要求；
(2). 从以往个人完成的项目中选择一个作品，例如：以往的数据结构课程设计或者其它具有比较完整功能的小系统，代码至少要大于100行；
(3). 将代码上传至个人GitHub或Coding.net系统中，并将代码地址交给对方；
(4). 对同伴的作品进行代码复审，并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容自行设计代码审查表并填写内容；
(5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里，博客中应该附有伙伴作业的GitHub或Coding.net的代码地址；
(6). 对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。
2.代码审查表
| 功能模块名称 | 简单语法分析程序 | ||
| 审查人 | 李苗 | 审查日期 | 2018.4.6 |
| 代码名称 | 简单语法分析程序 | 代码作者 | 蔡沛沛 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 无 | ||
| 重要 | 头文件是否使用了 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。 | |||
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 无 | ||
| （２）存在不同数据类型的赋值吗？ | 存在 | ||
| （３）存在不同数据类型的比较吗？ | 不存在 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 无 | ||
| （２）变量发生上溢或下溢吗？ | 不发生 | ||
| （３）变量的精度够吗？ | 够 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 否 | ||
| （２）表达式中的优先级有误吗？ | 无 | ||
| （３）逻辑判断结果颠倒吗？ | 否 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 正确 | ||
| （２）无法正常终止（死循环）吗？ | 否 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 否 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 否 | ||
| （２）错误处理程序块一直没有机会被运行？ | 否 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 否 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 否 | ||
| 重要 | 文件I/O问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | ||
| （２）文件以不正确的方式打开吗？ | 否 | ||
| （３）文件结束判断不正确吗？ | 否 | ||
| （４）没有正确地关闭文件吗? | 否 | ||
3.小结
在完成这次结对任务的作业中，我学习到了很多东西。首先，在这次结对作业之前，从没这么细致认真的看过其他同学的代码（一行一行逐字逐句的看），这次的作业要求，让我认识到了自己的这一缺点，也发现通过看其他人的代码不但可以学习到很多东西，还可以认识到自己的不足。比如，这次我的同伴蔡沛沛的代码写的很工整，很美观，让人很有看下去的念头。首先，她写的每一句话都很简洁，也很必要，不会拖拖拉拉，没有多余的变量定义；其次，定义变量的时候很直观，让人看了就能大概知道变量所指代的意思；还有就是她的代码的每一个模块都分得很清楚，而且也很直观，每一个‘{’及‘}’均各占一行，而且都在同一列对齐；对这一点，反思我自己的代码，我的代码并不是很清晰，‘{’及‘}’没有对齐，只是考虑到自己清楚，而没有考虑可读性；这一点，以后需要改正。
在看同伴的代码的同时也发现了一些小小的问题，比如，有一些语句特别的长，看起来很费劲，应该将长得语句划分的短些，增加可读性；还有就是switch那块的‘{’及‘}’未对齐，但语句整齐，并没有影响可读性；在判断逻辑关系的语句中，因为逻辑关系比较多，没有将各个语句加以括号区分，影响了可读性，查错的时候不方便，导致浪费时间。然而反观自己的代码，发现这样的错误也是随处可见，通过这次的代码复审，及时的发现了自己的诸多错误，以后一定改正。
对同伴代码的整体评价：同伴蔡沛沛的代码整体来说是很完美的，美观、可读，除了一些地方比较突兀的长以外，基本没什么缺点。
自己的感悟：以后一定要多看看别人的代码，学习他人的良好的习惯，改正自己的缺点。
代码链接：https://git.coding.net/Pepe10502/Four-with-lymiou.git
转载于:https://www.cnblogs.com/lymiou3335/p/8724304.html
软件工程第一次作业（结对作业）相关推荐
- 2022北航敏捷软件工程 第一次博客作业
2022北航敏捷软件工程 第一次博客作业 项目 内容 这个作业属于哪个课程 2022年北航敏捷软件工程 这个作业的要求在哪里 个人阅读作业-阅读和调研 我在这个课程的目标是 了解软件工程的方法论.在实 ...
- 第二次作业--结对作业
第二次作业--结对作业 结队队员:学号3030王倬楠, 学号3031林文雄 使用工具:墨刀组件 在在<构建之法>的第八章中,介绍了NABCD模型, NABCD模型(p154~p157): ...
- 北航 2012 秋季 现代软件工程 两人结对 作业要求
Pair Project: Elevator Scheduler [电梯调度算法的实现和测试] Design and implement an Elevator Scheduler to aim fo ...
- 软件工程实践2017结对作业
1.结对成员 031502643 朱晓健 031502626 孙浩楷 2.需求分析 Need 每到开学的时候,各大部门就会挤满青春广场通过各种方式来招收新成员.新生顶着烈日填写完申请表交由部门筛选,部 ...
- 软件工程第二次结对作业
四则运算生成器 任务 能够自动生成四则运算练习题 可以定制题目数量 用户可以选择运算符 用户设置最大数(如十以内.百以内等) 用户选择是否有括号.是否有小数 用户选择输出方式(如输出到文件.打印机等) ...
- 软件工程第一次个人编程作业
这个作业属于哪个课程 软件工程 这个作业要求在哪里 个人项目作业-论文查重 这个作业的目标 个人编程实现论文查重算法并进行测试检验 目录 一.项目链接 二.PSP表格 三.分包.接口设计与实现 四.性 ...
- 软件工程实践第三次作业——结对作业（一）
Link: 原型模型设计工具:墨刀.(在学长的推荐下发现有这一款十分好用的原型模型设计工具呢.^_^.) 小伙伴链接:http://www.cnblogs.com/mingsonic/p/968345 ...
- 软件工程第六次作业--结对作业
在线英语学习平台客户端原型 1.结对成员 刘博良 2015034643042 杨子龙 2015034643030 2.需求分析 使用NABCD模型进行需求分析 2.1 N(Need, 需求) 2.1. ...
- 福大软工1816 · 第五次作业 - 结对作业2
1.结对同学的博客链接.本作业博客的链接.所Fork的同名仓库的Github项目地址 Github地址:https://github.com/Stellaaa18/pair-project 结对同学的 ...
- 软工实践 第三次作业 结对作业一
Ⅰ.链接 结对同学博客戳我 本次作业戳我 Ⅱ.设计说明 问题重述 用户可给定论文列表 通过论文列表,爬取论文的题目.摘要.原文链接 可对论文列表进行增删改操作(今年.近两年.近三年) 对爬取的信息进行 ...
最新文章
- 调用wordcloud种种问题
- IOS之@property 的理解
- python ndarray append_9-Python-NumPy数组元素的添加与删除
- html5 实现波浪效果图,利用HTML5实现Canvas流动的波浪特效
- 实现裸金属服务器的安全微分段
- Centos 部署.net Core
- R语言--自定义函数证明中心极限定理
- paip.软件开发之COOKIE调试
- iOS源码分析：Block的本质
- 在线电子词典程序框架
- CronTrigger（重要，非常强大）
- unity摄像头实物识别_“千万别让女朋友擦倒车摄像头，太tm可怕了哈哈哈哈哈！”...
- 使用百度地图API在页面添加百度地图应用
- win7系统服务器停止,Windows7一个月后停止服务支持 Win7将于明年1月14日终止服务 停止服务后还能使用吗？...
- 扩展中国剩余定理模板
- mac 开机启动php,mac系统，php-fpm加入开机启动项
- IPv6下的DHCPv6
- 台式机耳机或音响使用
- Windows使用SSH Secure Shell实现免密码登录Linux的方法以及使用scp2命令免密码下载文件
- 水域智慧监测，水环境监测的全新革命！