软件工程第三次作业

沈阳航空航天大学
软件工程第三次作业

院（系）： 人工智能学院
专 业： 物联网工程
班 级： 物联网2102
学 号： 213428010204
姓 名： 姜羽
带队教师： 孟桂英

2024年4月22日

作业信息	沈阳航空航天大学计算机学院2024软件工程作业
课程目标	熟悉一个“高质量”软件的开发过程
作业目标	熟悉代码规范及结对互审
结对伙伴信息
专业	物联网工程
班级	物联网2102
学号	213428010203
姓名	张思盈
伙伴Github地址：	https://github.com/serendipityying/kruscal

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

2.对同伴的代码写一篇500字以上的评论，介绍同伴的优缺点。

通过仔细阅读了结对同伴的代码以及该同伴对其代码的详细讲解，对照代码编程规范以及评审检查，对比作出如下评价:
首先该代码符合题目背景和输出要求，整体看来明了简洁，并且遵守算法基本要求思想，正确性、可读性、可维护性及高效性。从正确性来看，运行代码输入符合要求的一组数据，能够得到正确且唯一的输出最小生成树结果，能够解决给定问题并给出正确答案，但仍存在一些不足，代码思想的覆盖范围不广，应该多考虑一些其他输入或者极端例子的输出结果，健壮性不强。从可读性来看，该代码在重要代码部分以及不同功能区都做出了不同的代码注释，变量定义名称也较为简洁，同时还拥有清晰的命名注释和缩进，易于他人阅读并轻松理解，因此代码可读性强。代码的功能模块清晰明了，结构良好，易于后期的维护和修改，并且可扩展，代码模块可重复利用。
其次对照审查表，该代码功能齐全，在大部分功能模块基本符合要求，在文件结构方面、程序的排版、命名规则、表达式和基本语句方面无明显错误，同样的，在其他方面同时存在不够完善的地方，例如没有错误处理程序块且没有函数入口的有效检查等。
最后，经过对结对同伴的代码审查，不仅仅是提高了对方代码的完整性和有效性，同时也使自己更加了解了代码规范要求，意识到自己曾经也可能会犯的错误，从而提升自己的代码编写能力。