【软工】第二次作业--代码复审
一、概要部分
- 代码能符合需求和规格说明么？
代码实现了生成数独和求解数独的基本功能，在合法输入下，能够输出合法的数据。
- 代码设计是否有周全的考虑？
在生成数独的问题下，对于输入的数字参数为负数、0、1-1000000、大于1000000以及非数字符号的情况都做了处理；在求解数独的情况下，对于输入的数独谜题为合法谜题、不合法谜题、残缺谜题都做了处理；此外，代码对非-c,-s的参数也做了处理。
- 代码可读性如何？
代码可读性一般，功能和意义相似的变量命名辨识度不高，初次读代码容易混淆。
- 代码容易维护吗？
代码基本上不能维护，没有采用面向对象的思想，整体全是面向过程地在处理问题，而且没有模块化，许多功能的移植性不强。
- 代码的每一行都执行并检查过了吗？
没有做到每一行都执行并检查，但关键功能代码的每一行都做了检查。
二、设计规范部分
- 设计是否遵从已知的设计模式或项目中常用的模式？
没有。
- 有没有硬编码或字符串/数字等存在？
有，因为算法使对于一些基础数独进行映射变换，所以代码里有字符串来表示这些基础数独。
- 代码有没有依赖于某一平台，是否会影响将来的移植（如Win32到Win64）？
因为题目的环境要求是在win10系统下的win64，所以在win64的平台上可以正常运行。
- 开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现？在本项目中是否存在类似的功能可以调用而不用全部重新实现？
不能。
- 没有无用的代码可以清除？（很多人想保留尽可能多的代码，因为以后可能会用上，这样导致程序文件中有很多注释掉的代码，这些代码都可以删除，因为源代码控制已经保存了原来的老代码。）
只有几行无用的代码，在文件中被注释掉了。可以清除。
三、代码规范部分
- 修改的部分符合代码标准和风格么（详细条文略）?
之前存在Tab的问题，现已修改。
四、具体代码部分
- 有没有对错误进行处理？对于调用的外部函数，是否检查了返回值或处理了异常？
有简单的对错误进行了处理，比如在打开文件时，如果文件不存在或者文件错误打不开会根据返回值对错误进行处理。
- 参数传递有无错误，字符串的长度是字节的长度还是字符（可能是单/双字节）的长度，是以0开始计数还是以1开始计数？
参数传递没有错误，字符串的长度是字符的长度，以0开始计数。
- 边界条件是如何处理的？Switch语句的Default是如何处理的？循环有没有可能出现死循环？
没有用到switch语句，循环都有明确的退出条件，不会出现死循环。
- 有没有使用断言（Assert）来保证我们认为不变的条件真的满足？
没有使用断言。
- 对资源的利用，是在哪里申请，在哪里释放的？有没有可能导致资源泄露（内存、文件、各种GUI资源、数据库访问的连接，等等）？有没有可能优化？
每次文件打开之后都会进行文件关闭的操作，不会导致文件资源的泄露。
- 数据结构中是否有无用的元素？
数据结构中有无用的元素，但该元素是为了在边界条件下程序仍能有效执行所设定。
五、效能
- 代码的效能（Performance）如何？最坏的情况是怎样的？
代码的效能能够满足需求，无论是生成数独功能还是数独求解功能，在规模为1000以内时，都可以在几秒内得到结果，能够通过正确性测试。在输入为1000000的时候，生成数独功能能够在几秒内很快的得到结果，求解数独功能则需要花费超过一分钟的时间。
- 代码中，特别是循环中是否有明显可优化的部分（C++中反复创建类，C#中string的操作是否能用StringBuilder 来优化）？
生成数独的循环中没有什么能够明显进行优化的操作，之前为了提高效率，已经尽可能的做了优化。求解数独的输出部分，现在的做法是一个字符一个字符的输出，可以整合到字符串里，最后一次性输出。
- 对于系统和网络调用是否会超时？如何处理?
没有网络调用，对系统的调用是有访问系统的时间，但这个是在调试时测试程序运行时间的时候加上的，为了提高效能可以删去。
六、可读性
- 代码可读性如何？有没有足够的注释？
代码的可读性还可以，变量的命名基本是按照变量的意义和功能来的。全部代码只有两行解读性质的注释。
七、可测试性
- 代码是否需要更新或创建新的单元测试？
代码修改后不需要更新或创建新的单元测试。但现有的单元测试可能称不上单元测试，只能叫做测试，直接从程序的整体部分进行测试，没有达到模块程度。
- 还可以有针对特定领域开发（如数据库、网页、多线程等）的核查表。
没有。
八、设计一个代码规范
- 工具提供的代码规范和你个人的代码风格有什么不同？
(1)没有copyright。
(2)tab应该替换成四个空格。
(3)注释和代码间要有空格。
(4)'{'要和代码同一行，且隔一个空格。
(5)每行长度小于等于80字符
- 工具提供的代码规范里有哪些部分是你之前没有想到的？
(1)没有copyright。
(2)tab应该替换成四个空格。
(3)注释和代码间要有空格。
(4)'{'要和代码同一行，且隔一个空格。
(5)每行长度小于等于80字符
- 为什么要这样规范？这样的规范有意义吗？
主要是让后来接手的开发人员快速精准的了解代码结构，以及代码思想，从而可以很好地在前人的基础上进行开发，同时也为后续的开发人员提供了好的开发基础。
当然有意义，举个实际的例子，我拿到过一份网站的前端代码，仅仅有两组开发人员进行开发，拿到的代码混乱不堪，也没有设计文档，style以及class的命名很多都是“拍脑袋”想出来的命名，这样导致我们在修改时产生了巨大的问题。如果有代码规范，整个的思路和实现过程就会好理解很多。
- 总结的代码规范
每行长度小于等于80字符
大括号换行
缩进使用四个Space
所有涉及大括号的语句，不要省略大括号
不在同一行写两条语句
类的私有属性使用下划线命名
类名采用名词命名，类中public方法采用动宾短语格式命名，其他变量采用驼峰式命名
尽量避免使用using namespace std;
不在一行声明两个及以上的变量
每个方法前后至少各空一行
声明方法时同一模块操作的尽量放到一起
按照头文件中声明的顺序写.cpp文件
