| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
1.代码地址
2.代码审查
文件结构
| 重要性 | 审查项 | 结论 |
|---|---|---|
| 不重要 | 头文件和定义文件的名称是否合理？ | 是 |
| 不重要 | 头文件和定义文件的目录结构是否合理 | 是 |
| 不重要 | 版权和版本声明是否完整？ | 无 |
| 重要 | 头文件是否使用了 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的语句是否正确无误？ |
3，总结
他的整体代码清晰完善，逻辑严谨，可以让读者很容易理解各模块的作用，可读性非常的高。通过本次结队作业，我了解到了原来书写代码有这么多的规范和要求，发现了这么多年来写代码留下的隐患。通过本次作业我对自己和我的搭档进行了一波总结反思，发现我们平时都没有很好的代码规范，这是我们应该注意的地方。通过总结和反思我觉得我们今后可以根据实际需求改进程序输入的方式，将界面和输入设计得更合理舒适些，这样编写的程序会更好。总而言之，本次作业结合上课老师所讲的内容，使我充分了解到结队编程的重要性，根据学习其他同学的代码，的确带给我更多的启发，学习到的东西也是很多的，在今后的代码编写的过程中，我也会注意所发现的问题，同时，我也会增进和同学之间的合作，相互学习，日后在自己的工作岗位上，发挥更好的作用。