个人作业Week2-代码复审

Posted 2020-10-09 作业 || 备忘录

一、代码复审Check List

1.概要部分

• 代码能符合需求和规格说明么？

　　　　可以实现生成和求解的基本需求，可以处理错误输出并输出提示信息，符合规格说明

• 代码设计是否有周全的考虑？

　　　　仍有欠缺，求解数独输出时可能会少输出

• 代码可读性如何？

　　　　较好，但稍有欠缺，相关评论：https://github.com/Lydia-yang/2017BUAA-SoftwareEngineering/issues/1

• 代码容易维护么？

　　　　模块划分较清晰，易于维护

• 代码的每一行都执行并检查过了吗？

　　　　博客中没有覆盖率报告，在求解数独时读取和输出有bug

2.设计规范部分

• 设计是否遵从已知的设计模式或项目中常用的模式？

　　　　没有使用设计模式

• 有没有硬编码或字符串/数字等存在？

　　　　有

• 代码有没有依赖于某一平台，是否会影响将来的移植（如Win32到Win64）？

　　　　不依赖

• 开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现？在本项目中是否存在类似的功能可以调用而不用全部重新实现？

　　　　没有可以直接调用的功能

• 有没有无用的代码可以清除？（很多人想保留尽可能多的代码，因为以后可能会用上，这样导致程序文件中有很多注释掉的代码，这些代码都可以删除，因为源代码控制已经保存了原来的老代码。）

　　　　有少量加了注释的代码

3.代码规范部分

• 修改的部分符合代码标准和风格么（详细条文略）?

　　　　符合，整体风格统一

4.具体代码部分

• 有没有对错误进行处理？对于调用的外部函数，是否检查了返回值或处理了异常？

　　　　有错误处理和返回值检查

• 参数传递有无错误，字符串的长度是字节的长度还是字符（可能是单/双字节）的长度，是以0开始计数还是以1开始计数？

　　　　无错误，字节的长度，从0开始。

• 边界条件是如何处理的？Switch语句的Default是如何处理的？循环有没有可能出现死循环？
• 有没有使用断言（Assert）来保证我们认为不变的条件真的满足？

　　　　没有

• 对资源的利用，是在哪里申请，在哪里释放的？有没有可能导致资源泄露（内存、文件、各种GUI资源、数据库访问的连接，等等）？有没有可能优化？

　　　　文件在打开读写后就立刻关闭，数独类在程序开始运行后申请，没有析构

• 数据结构中是否有无用的元素？

　　　　没有

5.效能

• 代码的效能（Performance）如何？最坏的情况是怎样的？

　　　　效能一般，生成100w个需要45.8s，求解5w个需要51.9s

• 代码中，特别是循环中是否有明显可优化的部分（C++中反复创建类，C#中string的操作是否能用StringBuilder 来优化）？

　　　　没有

• 对于系统和网络调用是否会超时？如何处理?

　　　　没有使用系统和网络调用

6.可读性

• 代码可读性如何？有没有足够的注释？

　　　　函数功能划分清晰，注释到位，但是没有头文件，而且有一定量注释掉的代码

7.可测试性

• 代码是否需要更新或创建新的单元测试？

　　　　需要进行更多测试，原博客中并未给出单元测试结果，程序运行时也有少量问题

• 还可以有针对特定领域开发（如数据库、网页、多线程等）的核查表。

　　　　没涉及到

二、设计一个代码规范

　　工具提供的代码规范和你个人的代码风格有什么不同？

• 没有copyright信息
• 应该先加载C头文件再加载C++头文件
• 注释和代码之间至少要有2个空格，“//”和注释内容之间要有一个空格
• 行宽应小于80个字符
• 用空格代替Tab
• else要接在“}”之后

　　工具提供的代码规范里有哪些部分是你之前没有想到的？

• 没有copyright信息
• 应该先加载C头文件再加载C++头文件
• else要接在“}”之后

　　为什么要这样规范？这样的规范有意义吗？

• 使用空格是为了统一代码风格，因为Tab在不同环境下显示的长度不同。由于旧的终端一行只能有80个字符才会有“行宽应小于80个字符”规定，虽然现在可以支持，但行宽太长也不利于阅读。
• 为了加强可读性和避免隐含依赖，应使用下面的顺序：C标准库、C++标准库、其它库的头文件、你自己工程的头文件。

　　在结对编程中使用的代码规范

• 缩进使用4个空格
• 行宽不能超过1000个字符
• 只有一个语句的if等结构也要使用大括号，而且每个{和}都单独占一行，以增强可读性
• 一行定义一个变量，不要在一行上写多个语句
• 类型/类/函数名的每个首字母都大写（Pascal形式），变量的第一个单词小写其余首字母大写（Camel形式）