small team
1.题目要求
传送门:软件工程(2018)结对编程第一次作业
- 从以往个人完成的项目中选择一个作品,例如:以往的数据结构课程设计或者其它具有比较完整功能的小系统,代码至少要大于100行;
- 将代码上传至个人GitHub或Coding.net系统中,并将代码地址交给对方;
对同伴的作品进行代码复审,并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容自行设计代码审查表并填写内容; - 将对伙伴审查的结果以表格的形式写到自己的博客作业里,博客中应该附有伙伴作业的GitHub或Coding.net的代码地址;
- 对同伴的代码写一篇500字以上的评论,介绍同伴的优缺点。
2.结对伙伴
队友:梁恒 + 郝志荣
3.代码复审
代码地址 : coding
功能模块名称 | 词法分析器 | ||
审查人 | 梁恒 | 审查日期 | 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。 | 无 | ||
其它常见问题 | |||
重要性 | 审查项 | 结论 | |
重要 | 数据类型问题: | 否 | |
(1)变量的数据类型有错误吗? | 否 | ||
(2)存在不同数据类型的赋值吗? | 否 | ||
(3)存在不同数据类型的比较吗? | 否 | ||
重要 | 变量值问题: | 否 | |
(1)变量的初始化或缺省值有错误吗? | 否 | ||
(2)变量发生上溢或下溢吗? | 否 | ||
(3)变量的精度够吗? | 是 | ||
重要 | 逻辑判断问题: | 是 | |
(1)由于精度原因导致比较无效吗? | 否 | ||
(2)表达式中的优先级有误吗? | 否 | ||
(3)逻辑判断结果颠倒吗? | 否 | ||
重要 | 循环问题: | 否 | |
(1)循环终止条件不正确吗? | 否 | ||
(2)无法正常终止(死循环)吗? | 否 | ||
(3)错误地修改循环变量吗? | 否 | ||
(4)存在误差累积吗? | 否 | ||
重要 | 错误处理问题: | ||
(1)忘记进行错误处理吗? | 否 | ||
(2)错误处理程序块一直没有机会被运行? | 否 | ||
(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 | 否 | ||
(4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 | 否 | ||
重要 | 文件I/O问题: | ||
(1)对不存在的或者错误的文件进行操作吗? | 否 | ||
(2)文件以不正确的方式打开吗? | 否 | ||
(3)文件结束判断不正确吗? | 否 | ||
(4)没有正确地关闭文件吗? | 否 | ||
4.评价总结
优点
首先,郝志荣的代码排版很规范,每个{和}都各占了一行,并且缩进很明显,让我对他的代码没有一点排斥。其次,他的代码对字符的处理分成了4个小函数,分别实现了一部分的功能,比如,数组的清零或者关键字的判别等,虽然这些函数实现的功能很少,但是对于我读代码起到了很大的帮助。最后,他在每个比较重要的函数和关键语句后面都添加了注释(据他说:以防以后忘了程序),这简直让我感觉在读自己的代码一样。
缺点
首先,他对所有的变量名称命名都很随意,并且许多名字都是重复的,这点让我很头疼,不过都在一个函数体里,而每个函数名都能让我望其字知其意。其次,他对数组的处理不符合规范,为了图方便,就直接让数组申请一个特大的空间,这真的是浪费啊!最后是关于代码注释,虽然注释很详细,但是也影响了读者的阅读效果,注释太啰嗦且不突出重点,对每一个函数或者功能块,缺乏必要的解释(可能有的太简单以至于懒得写)。
总结
其实,代码复查对于团队的合作是至关重要的。首先,通过对代码风格与命名规范的审查,可以极大地提高代码的可读性和代码质量。因为同在一个团队中,不可避免地要去读别人的代码并和别人交流,读懂代码可以说是合作的第一步吧!其次,通过对内存管理、类的构造函数、析构函数和赋值函数及高级特性等的复查是对代码的进一步纠错,从中也可以学习到很多别人的编程优点,提高自身的设计水平。
最后,我通过本次的代码审查作业,提高了和郝志荣的契合度,也从他的代码中学习到了一些提高自己编码效率的方法。我觉得自己对于编程有了更近一步的的认识,感觉以前编程就是单纯地为了编程,而现在得为队友考虑,得让队友也能理解代码的含义。希望在以后的编程任务中,我们能配合地很好!
转载于:https://www.cnblogs.com/liangheng/p/8727874.html
small team相关推荐
- Visual Studio 2005 Team System下载地址
注册一个msn就可以去微软下载了,关于替换序列号变成正版的方法我没有试,team suite 我在用,但Team Foundation Server 我还没有安装好 Microsoft Visual ...
- 高级网络配置《 bond team桥接 》的建立
bond 资料详情 一.链路聚合:以太网链路聚合简称链路聚合,它通过将多条以太网物理链路捆绑在一起成为一条逻辑链路,从而实现增加链路带宽的目的.同时,这些捆绑在一起的链路通过相互间的动态备份,可以有效 ...
- 安装Team Services Agent Win7
现状:项目现时使用的是Team Services,使用Team Services可以控制其中的一台Build Server,从Github提取代码,并在Build Server进入编译打包处理(son ...
- 微软MSIT部门招Sr SDE for FSS team
Job Description: Qualifications Do you want to design and build the services and solutions that are ...
- 【拾贝】版本控制-git 建立Team项目
提示一下:GitHub升级了 1. 网站升级后原来网站上有些教程图片有些问题 2. 客户端升级也引起了如下问题: 原来Git Shell 是这个路径 C:\Users\Administrator\Ap ...
- UVa540 Team Queue
// 题意:有t个团队的人在排队.每次来了一个新人之后,如果他有队友在排队,那么这个新人会插队到队友的身后. // 要求支持三种指令:ENQUEUE x; DEQUEUE(队首出队); STOP.模拟 ...
- Team Foundation Server安装指南(转)
1.说明 Team Foundation Server(以下简称VSTF)的安装并不是一件轻松的事情,在安装的过程中相信很多人都或多或少碰到一些问题而安装不成功,虽然手头有微软提供的所谓安装手册,也曾 ...
- 理解VMware Team中的虚拟网络
VMware Workstation 5.0(及其以后的版本)提供了"Team"功能.每个Team都包括"一组"虚拟机,以及多个虚拟交换机.Team是VMwar ...
- 在 Google Go Team 工作是一种怎样的体验?
专栏 | 九章算法 网址 | http://www.jiuzhang.com 个人背景 美国本科毕业.专业是是数学.本来以为大学会在数学这条路上一直走下去,直到某天,我一时兴起上了一节Java课,从此 ...
- Visual Studio 2005 Team System: Demo Videos
vs2005还没出来,Team System就炒得火热了,下面是他的一些视频demo. http://www.activewin.com/awin/comments.asp?HeadlineIndex ...
最新文章
- windows 如何安装oracle 补丁包,Windows Server 2003 上安装 Oracle10g(10.2.0.1)并升级 至补丁(10.2.0.4) 图解...
- 2014年最值得关注的六大趋势
- Java Web 高性能开发,前端的高性能
- 【洛谷P1538】迎春舞会之数字舞蹈
- 得到选择框句柄 怎么操作_电脑版微信怎么多开?最简单的三种电脑版微信多开教程...
- Shadow Map阴影贴图技术之探 【转】
- 不善待小狗的主人畜生不如
- 【设计模式】组合模式 Composite Pattern
- echarts y轴只显示5个刻度_ECharts 解决双Y轴刻度不一致问题
- 设计模式入门-模板模式
- SPPNet算法解析
- DirectX修复工具有什么用
- java 5分钟_java计算下一个整5分钟时间点
- 赠书 | 四大通证类型:价值创新的源头
- ros 校验数字签名时出错。此仓库未被更新,所以仍然使用此前的索引文件。
- Python编程:re中findall()用法
- to_date的用法
- 织梦转pbootcms插件,自动pbootcms插件
- 谷歌商店上架流程_Googleplay 上架流程(2022版)
- C++设计模式之策略模式(行为型模式)
热门文章
- 优化 | Pick and delivery problem的简介与建模实现(二)
- 大学计算机课桌面弄毛玻璃,高校换上新课桌,同学表示“世界观被颠覆”,网友:黑科技的诞生...
- 【设计模式】—-(12)代理模式(结构型)
- 崩坏星穹铁道PC、安卓、iOS三端配置要求
- echart折线区域图
- echarts折线图 - 区域图 -如何设置填充色
- 计算机二级 word 论文,最新计算机二级第十四套word题目要求
- 如何把照片压缩到20k一下_如何将照片压缩到20k_手机怎么把照片压缩到20k
- [趣味文学]“帅气”的莎士比亚
- 电脑计算机怎么没有桌面显示器,如果您听不懂,请问为什么计算机显示器没有OLED屏幕?...