一、代码审查表
结对同学姓名:高宏鑫
领航员(艾婷婷)代码地址
https://github.com/1att2/hello/blob/main/%E8%89%BE%E5%A9%B7%E5%A9%B7%E5%AE%9E%E9%AA%8C%E4%BA%8C
驾驶员(高宏鑫)代码地址
https://github.com/gao422/work/blob/main/%E5%9B%9B%E5%88%99%E8%BF%90%E7%AE%97
功能模块名称 |
语法分析器 |
||
审查人 |
艾婷婷 |
审查日期 |
2022-11-12 |
代码名称 |
四则运算 |
代码作者 |
高宏鑫 |
表1.2代码审查表
序号 |
重要性 |
审查项 |
结论 |
||
1 |
重要/不重要 |
审查表中待检查内容 |
填写是/否/无(是代表符合规范,否代表不符合规范,无代表代码不涉及该项内容) |
||
|
|
头文件和定义文件的名称是否合理? |
是 |
||
|
|
头文件和定义文件的目录结构是否合理? |
是 |
||
|
|
|
是 |
||
|
重要 |
头文件是否使用了 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)缺省的拷贝构造函数; |
否 |
||
|
|
|
否 |
||
|
|
(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、对于循环结构选择了较为简便的算法,减少了循环次数,提高了程序效率。
4、没有出现语法错误,代码书写规范,正确率高。
5、没有在同一行中出现两个或两个以上的功能语句
缺点:
1、对于不同功能的函数,没有进行模块化处理。
2、对于部分较长的语句没有进行换行处理,是整体显得有些凌乱。
3、部分地方出现未换行
总结
队友的这个程序整体上还是达到了本次作业的要求,功能完整,内容丰富,条理清晰,并且可以看出通过对软件工程这门课程的学习,对这个项目进行了进一步的优化,比如在文件函数等命名上,都十分的规范,增加了代码的可读性,对于循环语句的处理也尽可能地减少了循环嵌套的出现,大大增加了程序的运行效率,可以看出,通过对软件工程的学习,队友的程序管理和协调能力还是有大幅提升的。然而,也许是时间较为紧迫,还是有一些美中不足的问题存在,比如代码过于整体化,没有进行模块化处理,这样导致日后增加功能以及debug处理上会浪费大量时间,无法精确定位到出错部分。除此之外对于长语句也没能进行切割,使得整体显得较为凌乱。
总的来说,通过这次的审查可以发现我的队友的软件管理能力还是得到非常大的提升,同时我自己在审查过程中也发现了许多自己犯的错误,也在潜移默化中得到了提升,我认为下一次的结对作业我们都可以较这一次有较大的提升。很感谢老师给的这次作业的机会,让我们的能力得到提高。
2.选做题
代码审查
序号 |
重要性 |
审查项 |
结论 |
1 |
重要/不重要 |
头文件和定义文件的名称是否合理 |
是 |
2 |
重要/不重要 |
头文件和定义文件的目录是否合理 |
是 |
3 |
重要/不重要 |
头文件是否使用了 ifndef/define/endif 预处理块? |
是 |
4 |
重要/不重要 |
头文件中是否只存放“声明”而不存放“定义” |
否 |
5 |
重要/不重要 |
空行是否得体 |
是 |
6 |
重要/不重要 |
代码空行是否得体 |
是 |
7 |
重要/不重要 |
“{”和“}”是否各占一行并且对齐于同一列 |
是 |
8 |
重要/不重要 |
一行代码是否只做一件事。如只定义一个变量,只写一条语句 |
是 |
9 |
重要/不重要 |
If,for,while,do等语句各占一行,不论执行多少语句都加“{}” |
是 |
10 |
重要/不重要 |
在定义变量时,是否将修饰符*和&紧靠变量名,注释是否清晰并且必要 |
是 |
11 |
重要/不重要 |
注释是否有错误 |
否 |
12 |
重要/不重要 |
标识符是否直观且可以拼读 |
是 |
13 |
重要/不重要 |
标识符的长度应符合”min-length&&max-information”原则 |
是 |
14 |
重要/不重要 |
程序中是否出现了相同的局部变量和全部变量 |
是 |
15 |
重要/不重要 |
类名,函数名,变量是否遵循一致原则 |
是 |
16 |
重要/不重要 |
参数命名,顺序是否合理 |
是 |
17 |
重要/不重要 |
是否用内函数取代了宏代码 |
否 |
18 |
重要/不重要 |
是否违背编程规范化而让c++自动为类而产生缺省函数 |
否 |
19 |
重要/不重要 |
文件以不正确的方式打开吗 |
否 |
20 |
重要/不重要 |
文件结束判断不正确吗 |
否 |
3.总结与体会
总结成一句话,两个人就是比一个人强。这次编程首先我要感谢我的队友高宏鑫同学,总体来说结对实验比个人工作要高效很多。
本次结对编程花费时间较长、收货较大的地方主要是:
1、生成试题的过程。实现没有括号的试题生成还是比较简单的,但是一旦加入括号同时还要保证最后的结果是有意义就比较难了。我们想了几种思路最后都没有通过,例如先设定几种添加括号方式的模板,然后随机这几种模板,还有一些根本就实现不了,经过一番努力,最终我们选择了上面这种思路。
2、在测试运算结果的时候,我们发现我们口算的结果和程序运算的结果不相同,经过排查发现了是因为在计算后缀表达式的时候弹出两个操作数进行计算,先弹出的操作数实际上是第二个数字,后弹出来的实际上是第一个数字,这样就像是原本题目是“2-1”,但是程序运算的却是“1-2”的结果,一开始的时候我想当然的将先弹出的数字当做第一个操作数,后弹出的数字当做第二个操作数,这个地方真的是耗费了我们很多时间。
3、生成试题的时候保证生成试题的结果是有意义的,这里刚开始完成功能一的时候还是比较容易的,但是加入括号后就比较复杂了,所以在这里也花费了很长时间。
4、将中缀表达转换成后缀表达式的实现过程。以前学数据结构一直都是理论上的学习,只会在纸上用笔转换,从来没有落实到代码上面,通过这次编程算是跌跌撞撞的实现了这一功能。
标签:语句,结对,重要,函数,是否,代码,四则运算,婷婷,变量 From: https://www.cnblogs.com/att1/p/16883717.html