软件工程——结对编程第一次作业

目录

• 1. 代码地址
• 2. C/C++代码审查表
• 3. 代码评价

1. 代码地址

这个项目由王宗波编写，并且已提交至Coding.net系统中,该项目实现的是霍夫曼编码（霍夫曼树）的算法，使用C/C++语言开发。

2. C/C++代码审查表

参照这篇CSDN博文中的内容设计了如下的C/C++代码审查表，并根据此项目的代码进行审查和填写。

项目名称	霍夫曼编码
审查人	张浩宇	审查日期	2019/4/21
代码名称	结对作业1.cpp	代码作者	王宗波
文件结构
序号	审查项目	重要性	结论	备注
1	头文件和定义文件的名称是否合理？		√
2	头文件和定义文件的目录结构是否合理？		√
3	版权和版本声明是否完整？		不适用	作为作业，不需要版权信息
4	头文件是否使用了 ifndef/define/endif 预处理块?	重要	不适用	未使用自订的头文件
5	头文件中是否只存放“声明”而不存放“定义”？		不适用	未使用自订的头文件
程序版式
序号	审查项目	重要性	结论	备注
6	代码段间的空行是否得体？		×	代码前预处理部分和正式代码间未换行，每个函数间未换行
7	代码行内的空格是否得体？		√
8	长行拆分是否得体？		×	部分较长语句未换行
9	“{” 和 “}” 是否各占一行并且对齐于同一列？		√
10	一行代码是否只做一件事？如只定义一个变量，只写一条语句。	重要	×	部分语句定义了多个变量
11	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	重要	×	部分只有一句有效语句的判断、循环未加大括号
12	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？	重要	不适用	未使用指针变量
13	注释是否清晰并且必要？	重要	√
14	注释是否没有错误且不会导致误解？	重要	√
15	类结构的public, protected, private顺序是否在所有的程序中保持一致？	重要	不适用	未使用类
命名规则
序号	审查项目	重要性	结论	备注
16	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	重要	√
17	标识符是否直观且可以拼读？		×	标识符直观，但部分不可拼读
18	标识符的长度应当符合“min-length && max-information”原则？		√
19	程序中是否出现相同的局部变量和全部变量？	重要	×	部分计数变量重复、命名相同
20	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？		√
21	静态变量、全局变量、类的成员变量是否加前缀？		×
表达式与基本语句
序号	审查项目	重要性	结论	备注
22	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	重要	√	未出现较为复杂的运算
23	是否未编写太复杂或者多用途的复合表达式？		√
24	是否未将复合表达式与“真正的数学表达式”混淆？	重要	√
25	是否用正确的方式写if语句? 例如	重要
	1) 不将布尔变量直接与TRUE、FALSE或者1、0进行比较。		√	未使用bool型变量
	2) 不将浮点变量用“==”或“！=”与任何数字比较。		√	未使用浮点变量
	3) 不将指针变量用“==”或“！=”与NULL比较。		√	未使用指针变量
26	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？		√	循环体内的逻辑判断均为必须处在循环内的
27	Case语句的结尾是加了break？	重要	√
28	是否写了switch的default分支？	重要	√
29	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	重要	不适用	未使用goto语句
常量
序号	审查项目	重要性	结论	备注
30	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？		√
31	是否误解了类中的const数据成员？因为const数据成员只在某个对象		不适用	未使用类
32	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	重要	√
33	生存期内是常量，而对于整个类而言却是可变的。		√
函数设计
序号	审查项目	重要性	结论	备注
34	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。		√
35	参数命名、顺序是否合理？		√
36	参数的个数是否太多？		×
37	是否使用类型和数目不确定的参数？		×
38	是否省略了函数返回值的类型？		×
39	函数名字与返回值类型在语义上是否冲突？		×
40	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	重要	√
41	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	重要	×
42	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	重要	×	未使用assert
43	return语句是否返回指向“栈内存”的“指针”或者“引用”？	重要	×
44	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。		×
内存管理
序号	审查项目	重要性	结论	备注
45	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？	重要	不适用	未使用malloc
46	是否忘记为数组和动态内存赋初值？	重要	×	数组未赋初值，未使用动态内存
47	数组或指针的下标是否越界？	重要	×
48	动态内存的申请与释放是否配对？	重要	不适用	未使用动态内存
49	是否有效地处理了“内存耗尽”问题？	重要	√
50	是否修改“指向常量的指针”的内容？	重要	不适用	未使用指针
51	是否出现野指针？例如	重要		未使用指针
	1) 指针变量没有被初始化		×
	2) 用free或delete释放了内存之后，忘记将指针设置为NULL。		×
52	是否将malloc/free 和 new/delete 混淆使用？	重要	×	未使用malloc/free和new/delete
53	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	重要	不适用	未使用malloc语句
54	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	重要	不适用	未使用动态对象数组
其它常见问题
序号	审查项目	重要性	结论	备注
55	数据类型问题：	重要
	1) 变量的数据类型有错误吗？		×
	2) 存在不同数据类型的赋值吗？		×
	3) 存在不同数据类型的比较吗？		×
56	变量值问题：	重要
	1) 变量的初始化或缺省值有错误吗？		√
	2) 变量发生上溢或下溢吗？		×	取决于输入的数字大小，一般情况下不会，但未作容错处理
	3) 变量的精度够吗?		√	均为整型，不存在精度问题
57	逻辑判断问题：	重要
	1) 由于精度原因导致比较无效吗？		×
	2) 表达式中的优先级有误吗？		×
	3) 逻辑判断结果颠倒吗？		×
58	循环问题：	重要
	1) 循环终止条件不正确吗？		×
	2) 无法正常终止（死循环）吗？		×
	3) 错误地修改循环变量吗？		×
	4) 存在误差累积吗？		×
59	错误处理问题：	重要
	1) 忘记进行错误处理吗？		×
	2) 错误处理程序块一直没有机会被运行？		×
	3) 错误处理程序块本身就有毛病吗？		×
	4) 错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。		×
60	文件I/O问题：	重要		未对文件进行操作
	1) 对不存在的或者错误的文件进行操作吗？		×
	2) 文件以不正确的方式打开吗？		×
	3) 文件结束判断不正确吗？		×
	4) 没有正确地关闭文件吗?		×

3. 代码评价

王宗波同学的这个项目的代码，使用C/C++语言进行开发，整体结构较为工整清晰，命名和书写等较有条理，代码风格具有一定的规范性，但也有部分的不足。

其主要优点如下。

首先对代码的整体结构有较为清晰的把握，只声明了所使用的库函数的头文件，没有头文件被声明而未被使用。

语句与语句间使用换行明确区分，缩进得当，且大部分的循环体、判断结构均用“{”和“}”加以明示，代码可读性较强。

每一个循环体都是有效、正确且可以正常结束的循环。

注释清晰简洁且通俗易懂，增加了代码的可读性。

变量的命名虽未遵循某些约定俗成的规则，如匈牙利命名法等，但仍有规律可循，且大部分的变量均体现出了该变量的作用或含义。

例如代码中这一段的变量命名均含义清楚准确

typedef struct
{
    char data;       //结点值
    int weight;      //权值
    int parent;      //双亲节点
    int left;        //左节点
    int right;       //右节点
    int flag ;       //访问标志
} huffnode;          //哈夫曼树的结点

在使用switch选择时，正确使用了比较容易忽视的default语句，且在每个case选项后均正确使用的break，保证了选择结果的正确性。

例如代码中的这一段，对switch的使用十分准确

switch(key)
        {
        case '1':
            n=Input_haffuman();
            break;
        case '2':
            display_huffcode(n);
            break;
        case '3':
            Huffman_code(n);
            break;
        case '4':
            Equilong_code(n);
            break;
        case '5':
            Compare_code(n);
            break;
        case '6':
            Encoder(n);
            break;
        case '0':
            Print3();
            break;
        default:
            cout<<"选择无效，请重新选择！！"<<endl;
            break;

在程序的开始部分，使用#define MAXSIZE 10000语句较为清楚的声明了整个程序中使用次数较多的数字1000为MAXSIZE，方便了后续的使用且能有效地避免出错。

在函数设计方面，正确、合理且有序的设计了各项传递的参数，没有偷工减料的省略参数的名字而只是用参数类型。

在数据结构和数据类型的设计方面，选择了正确的数据类型和合理的数据结构来储存要处理和计算的数据。

设计了容错机制和错误处理程序，有效的增强了程序的健壮性。

但是仍然存在部分缺点和不足。

首先是所有的功能函数和主函数都设计在同一个cpp文件内，不利于程序的迁移等，可以尝试将功能函数声明在定义的头文件内，并在头文件对应的cpp文件内进行设计，主程序单独的设计在一个cpp文件内，并通过添加头文件对功能函数进行调用。

其次部分只有一句的判断结构和循环体没有大括号，虽然正确，但是不利于后期的修改。

另外，建议在命名变量时，在符合规则和易懂的基础上，设计为容易拼读的变量名，这样可增加程序的可读性。

在函数设计方面，可以在函数入口处使用assert进行参数的有效性检查，并可在适当的时候使用const，这样可以提高函数的健壮性。

另外整个项目在未知需要处理的数据的个数的前提下，使用了固定的数组大小并不合适，简易使用动态的内存分配，以便优化内存大小。

最后，虽然设计了容错机制但是并不完备，忽视了一些极小概率发生的错误，如整型变量数值溢出的处理。

总的来说这个项目的代码，在没有系统学习过某种特定的代码规范的情况下，还是相当的不错的，但是仍有很大的进步空间。