软件工程第三次作业

软件工程第一次结对作业

一、作业公共信息区

博客信息	沈阳航空航天大学计算机学院2020软件工程作业
作业要求	https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616
课程目标	熟悉一个“高质量”软件的开发过程
作业目标	熟悉代码规范及结对互审

二、代码信息

Github代码查看

三、代码审查

功能模块名称	学生成绩管理系统
审查人	李世伟	审查日期	2020/4/13
代码名称	学生成绩管理系统	代码作者	陈程
文件结构
重要性	审查项	结论
不重要	头文件和定义文件的名称是否合理？	无
不重要	头文件和定义文件的目录结构是否合理？	无
不重要	版权和版本声明是否完整？	无
重要	头文件是否使用了 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问题：
	（１）对不存在的或者错误的文件进行操作吗？	无
	（２）文件以不正确的方式打开吗？	无
	（３）文件结束判断不正确吗？	无
	（４）没有正确地关闭文件吗?	无

四、代码评价

  首先，介绍一下我的队友，是计科1701的陈程同学。他所上传的代码是他的数据结构课程设计，即实现一个学生成绩管理系统。并且要求该系统具有以下功能：
1. 录入、修改和删除学生信息；
2. 查询：按照姓名或学号查询，查找算法要求使用折半查找算法；
3. 学生成绩排序、分类，平均成绩计算等。
根据以上要求，我对他的代码进行了审查，并且有一些看法和建议，下面逐一进行介绍。

优点：
  首先来说数据的存储方式，在本系统的设计中，他所采用的数据结构为链表。通过对链表的增删查改，实现对学生信息的一些操作，我认为这是很好的地方，能够合理的运用链表这种数据结构，可以实现对内存空间的合理利用，在这方面值得我去学习。
  在排序算法上采用了折半算法，这也是根据题目要求来的，这是一个比较好的地方，在时间复杂度上控制的很好。就我个人而言，在进行排序的时候首先想到的是能否正确排序，并不会理会程序中时间复杂度是如何，这是我需要向他学习并且进行改进的地方。
缺点：
  在代码中对变量的命名这一部分，我认为他做的不是很好。变量名称定义的比较混乱，可读性不是很好，如下所示：

    struct chen
{
    char a[20];         //姓名
    char b;             //性别
    char c[20];          //电话 学生证件号
    char d[20];         //e—mail 专业
    char e[20];         //城市 班级
    int f;         //成绩
    struct chen *next;
};

  这是他的代码中的结构体信息定义，并没有给取得合适的变量名，在对代码进行修改的过程中相信会很吃力，如果能够取得合适的变量名称，不仅可读性会变得很好，而且在对代码进行调试、修改、增加模块时也会事半功倍，我认为这是可以改进的地方，并且也是在程序设计初期容易改进的地方。
  在代码注释方面还有待改进，由于变量定义较为混乱，我认为此时应该多进行注释以弥补不足，并且注释的地方并不够清晰明了，不是很容易就能够读懂注释，比如以下代码注释：

int main()
{
    chen *p,*q,*x;
    int n;
    cin>>n;
    p=create(n);          //输入
    q=line(p);            //排序
    x=q;
    panduan(x);
    int a,b,i;
    cin>>i;
    while(i>0)
    {
        cin>>a;
        cin>>b;
        if(a==0)
    {
        if(b==1)               //输入姓名修改 a=0 b=1
       {
        p=xiugai(q);
        while(p)
        {
            cout<<p->a<<" "<<p->b<<" "<<p->c<<" "<<p->d<<" "<<p->e<<" "<<p->f<<endl;
            p=p->next;
        }
       }
       if(b==2)                //输入姓名删除 a=0 b=2
       {
           p=shanchu(q);
         while(p)
        {
            cout<<p->a<<" "<<p->b<<" "<<p->c<<" "<<p->d<<" "<<p->e<<" "<<p->f<<endl;
            p=p->next;
        }
       }
       if(b==0)                 //输入姓名查询   a=0 b=0
       {
           chaxun1(q);
       }
    }
    if(a==1)
    {
         if(b==1)               //输入学号修改 a=1 b=1
       {
        p=xiugai1(q);
        while(p)
        {
            cout<<p->a<<" "<<p->b<<" "<<p->c<<" "<<p->d<<" "<<p->e<<" "<<p->f<<endl;
            p=p->next;
        }
       }
       if(b==2)                //输入学号删除 a=1 b=2
       {
           p=shanchu1(q);
         while(p)
        {
            cout<<p->a<<" "<<p->b<<" "<<p->c<<" "<<p->d<<" "<<p->e<<" "<<p->f<<endl;
            p=p->next;
        }
       }
       if(b==0)                 //输入学号查询   a=1 b=0
       {
           chaxun2(q);
       }
    }
    cin>>i;
    }
    return 0；
}

  以上是他对主函数中的注释，我认为并不够清晰明了。同时我觉得在主函数中可以通过引入"switch"与“case"来减少判断语句，也可以使代码量减少。同时我认为还可以通过在主函数循环体内增加“清屏”功能，每执行完一次循环后，可以清屏，使使用的界面更加美观并且不容易操作错误。
  最后，在程序中缺少出错处理和对文件的读写操作。在他的代码中并没有出错处理，容错性很低，一旦输入错误，程序可能会直接退出，而此时，我们希望得到的是一段对输入错误的提示，这个地方需要进行改进。还有对文件的操作，本系统应该是可以进行多次使用的，而不是在使用完一次后，所保存的数据就消失了。因此可以在代码中加入文件的读取与存储模块，将使用后的数据信息进行保存下来，从而使数据不会丢失，这样，本系统便可以长期进行使用了。