选做题实验过程
一、题目要求
(1) 从以往个人完成的项目中选择一个作品,例如:以往的具有比较完整功能的小系统,代码至少要大于100行。
(2) 将代码上传至个人GitHub系统中,并将代码地址交给对方;
(3) 对同伴的作品进行代码复审,并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容将检查内容填入以下代码审查表中;
(4) 将对伙伴审查的结果以表格的形式写到自己的作业里,作业中应该附有伙伴作业的GitHub代码地址。
(5) 对同伴的代码写一篇500字以上的评论,介绍同伴的优缺点
二、复审代码题目
设计一小型成绩管理系统,根据功能需要自己设计存储结构,系统主要功能如下:
(1)录入、修改和删除学生信息;
(2)查询:按照姓名或学号查询,查找算法要求使用折半查找算法;
(3)学生成绩排序、分类,平均成绩计算等。
注:学生基本信息:姓名,学生证件号,专业,班级和性别等。
三、结对伙伴代码地址
github代码地址:https://github.com/1lh2/lvhao/blob/main/test
四、C/C++代码审查表
序号 |
重要性 |
审查项 |
结论 |
文件结构 |
|
|
|
1 |
重要 |
头文件和定义文件的名称是否合理? |
是 |
2 |
重要 |
头文件和定义文件的目录结构是否合理? |
是 |
3 |
不重要 |
版权和版本声明是否完整? |
无 |
4 |
重要 |
|
否 |
5 |
不重要 |
头文件中是否只存放“声明”而不存放“定义” |
否 |
程序版式 |
|
|
|
1 |
不重要 |
空行是否得体? |
是 |
2 |
不重要 |
代码行内的空格是否得体? |
是 |
3 |
不重要 |
长行拆分是否得体? |
是 |
4 |
不重要 |
“{” 和 “}” 是否各占一行并且对齐于同一列? |
是 |
5 |
重要 |
一行代码是否只做一件事?如只定义一个变量,只写一条语句。 |
是 |
6 |
重要 |
If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 |
是 |
7 |
重要 |
在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要? |
是 |
8 |
重要 |
注释是否有错误或者可能导致误解? |
否 |
9 |
重要 |
类结构的public, protected, private顺序是否在所有的程序中保持一致? |
是 |
命名规则 |
|
|
|
1 |
重要 |
|
是 |
2 |
不重要 |
标识符是否直观且可以拼读? |
是 |
3 |
不重要 |
标识符的长度应当符合“min-length && max-information”原则? |
是 |
4 |
重要 |
程序中是否出现相同的局部变量和全部变量? |
否 |
5 |
不重要 |
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? |
是 |
6 |
不重要 |
静态变量、全局变量、类的成员变量是否加前缀? |
是 |
表达式与基本语句 |
|
|
|
1 |
重要 |
如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? |
是 |
2 |
不重要 |
是否编写太复杂或者多用途的复合表达式? |
否 |
3 |
重要 |
|
否 |
4 |
重要 |
是否用隐含错误的方式写if语句? 例如 |
否 |
5 |
重要 |
|
否 |
6 |
重要 |
(2)将浮点变量用“==”或“!=”与任何数字比较。 |
否 |
7 |
重要 |
(3)将指针变量用“==”或“!=”与NULL比较。 |
是 |
8 |
不重要 |
|
否 |
9 |
不重要 |
断移到循环体的外面? |
否 |
10 |
重要 |
|
否 |
11 |
重要 |
|
否 |
12 |
重要 |
使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 |
否 |
常量 |
|
|
|
1 |
不重要 |
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? |
是 |
2 |
不重要 |
|
无 |
3 |
重要 |
如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? |
是 |
4 |
不重要 |
|
否 |
5 |
不重要 |
|
是 |
函数设计 |
|
|
|
1 |
不重要 |
参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 |
是 |
2 |
不重要 |
参数命名、顺序是否合理? |
是 |
3 |
不重要 |
参数的个数是否太多? |
否 |
4 |
不重要 |
是否使用类型和数目不确定的参数? |
否 |
5 |
不重要 |
|
否 |
6 |
不重要 |
|
否 |
7 |
重要 |
是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 |
否 |
8 |
重要 |
|
否 |
9 |
重要 |
|
否 |
10 |
重要 |
|
否 |
11 |
不重要 |
是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need”
|
否 |
内存管理 |
|
|
|
1 |
重要 |
用malloc或new申请内存之后,是否立即检查指针值是否为NULL?(防止使用指针值为NULL的内存) |
是 |
2 |
重要 |
是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用) |
否 |
3 |
重要 |
数组或指针的下标是否越界? |
否 |
4 |
重要 |
|
是 |
5 |
重要 |
|
是 |
6 |
重要 |
是否修改“指向常量的指针”的内容? |
否 |
7 |
重要 |
是否出现野指针?例如(1)指针变量没有被初始化;(2)用free或delete释放了内存之后,忘记将指针设置为NULL。 |
否 |
8 |
重要 |
|
否 |
9 |
重要 |
|
是 |
10 |
重要 |
|
是 |
|
|
|
|
C++函数的高级特性 |
|
|
|
1 |
不重要 |
重载函数是否有二义性? |
否 |
2 |
重要 |
是否混淆了成员函数的重载、覆盖与隐藏? |
否 |
3 |
不重要 |
运算符的重载是否符合制定的编程规范? |
是 |
4 |
不重要 |
是否滥用内联函数?例如函数体内的代码比较长,函数体内出现循环。 |
否 |
5 |
重要 |
是否用内联函数取代了宏代码? |
否 |
类的构造函数、析构函数和赋值函数 |
|
|
|
1 |
重要 |
|
|
2 |
重要 |
(1)缺省的无参数构造函数; |
否 |
3 |
重要 |
|
否 |
4 |
重要 |
(3)缺省的析构函数; |
否 |
5 |
重要 |
(4)缺省的赋值函数。 |
否 |
6 |
重要 |
构造函数中是否遗漏了某些初始化工作? |
否 |
7 |
重要 |
|
是 |
8 |
重要 |
析构函数中是否遗漏了某些清除工作? |
否 |
9 |
重要 |
|
否 |
10 |
重要 |
|
|
11 |
重要 |
(1)检查自赋值; |
是 |
12 |
重要 |
|
是 |
13 |
重要 |
|
是 |
14 |
重要 |
(4)返回 *this。是否遗漏了重要步骤? |
否 |
15 |
重要 |
|
无 |
16 |
重要 |
|
|
17 |
重要 |
(1)派生类不可能继承基类的构造函数、析构函数、赋值函数 |
无 |
18 |
重要 |
(2)派生类的构造函数应在其初始化表里调用基类的构造函数 |
无 |
19 |
重要 |
(3)基类与派生类的析构函数应该为虚(即加virtual关键字) |
无 |
20 |
重要 |
(4)在编写派生类的赋值函数时,注意不要忘记对基类的数据成员重新赋值 |
无 |
类的高级特性 |
|
|
|
1 |
重要 |
|
|
2 |
重要 |
(1)若在逻辑上B是A的“一种”,并且A的所有功能和属性对B而言都有意义,则允许B继承A的功能和属性。 |
无 |
3 |
重要 |
|
无 |
其他问题 |
|
|
|
1 |
重要 |
数据类型问题: |
|
2 |
|
(1)变量的数据类型有错误吗? |
无 |
3 |
|
|
无 |
4 |
|
|
无 |
5 |
重要 |
变量值问题: |
|
6 |
|
(1)变量的初始化或缺省值有错误吗? |
无 |
7 |
|
(2)变量发生上溢或下溢吗? |
无 |
8 |
|
(3)变量的精度够吗? |
够 |
9 |
重要 |
|
|
10 |
|
|
无 |
11 |
|
(2)表达式中的优先级有误吗? |
无 |
12 |
|
(3)逻辑判断结果颠倒吗? |
无 |
13 |
重要 |
|
|
14 |
|
(1)循环终止条件不正确吗? |
无 |
15 |
|
(2)无法正常终止(死循环)吗? |
无 |
16 |
|
(3)错误地修改循环变量吗? |
无 |
17 |
|
(4)存在误差累积吗? |
无 |
18 |
重要 |
|
|
19 |
|
(1)忘记进行错误处理吗? |
否 |
20 |
|
|
否 |
21 |
|
(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 |
否 |
22 |
重要 |
文件I/O问题: |
|
23 |
|
(1)对不存在的或者错误的文件进行操作吗? |
否 |
24 |
|
(2)文件以不正确的方式打开吗? |
否 |
25 |
|
|
否 |
26 |
|
|
否 |
五、复审评论
本课程设计的代码实现了特殊的折半查找算法,实现了对学生成绩在文件中的读写。本课程设计的代码完成质量较高,可以较好的实现题目中的要求。
代码的主要优点:
- 代码编写清晰工整,没有使用拼音来编写变量,编码规范。
- 对变量的命名直观
- 注释详细,即使第一次看也能很快了解代码的意思。
- 各个部分的实现均有各自的函数,函数名也由所实现的英文组成,清晰明了。
- 运行界面美观、流畅,并且支持重复使用,对学生成绩所实现的功能情况考虑的周全。
代码的主要缺点:
1. 程序运行一个功能后没有立刻返回主菜单,而进行下一个功能,可以设计返回主菜带的选项。
2. 若能实现模糊查找就更好了。
通过对伙伴的代码进行审查,我对C/C++代码的格式规范的理解更加深刻了,也懂得了在项目的开发过程中需要考虑到程序的可读性、扩展性、执行效率等方面是否完善。在审查伙伴代码的过程中,我也不断反思自己代码存在的问题,也要不断地提高自己的能力,写出更好的代码。
标签:选做,重要,函数,是否,代码,软件工程,实验,变量,构造函数 From: https://www.cnblogs.com/syx1129/p/16885936.html