个人作业Week2-代码复审
一、代码复审Check List
1.概要部分
(1).代码能符合需求和规格说明么?
存在一些问题:
1.生成数独格式不符合要求,生成数独未换行无空格
要求:
而实际生成:
2.未对不规范输入做出处理,这方面还未实现
3.生成1000000个数独跑不出来
(2).代码设计是否有周全的考虑?
设计时不排除有生成重复数独的可能
(3).代码可读性如何?
可读性良好,函数命名用的拼音,虽然可以理解但希望改进,然后一些变量的定义要含义的命名,这样可提高可读性。
(4).代码容易维护么?
维护性还可以,有些函数有些繁重,不过函数划分较为清晰,分隔比较容易理解。
(5).代码的每一行都执行并检查过了吗?
执行并检查了。
2.设计规范部分
(1).设计是否遵从已知的设计模式或项目中常用的模式?
暂未涉及到什么设计模式
(2).有没有硬编码或字符串/数字等存在?
有,如下
(3).代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到Win64)?
是windows下实现,依赖windows;
(4).开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?
没有,不存在的。
(5).有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码。)
有,求解和自动生成中有很多代码重复,可以清除。
3.代码规范部分
修改的部分符合代码标准和风格么(详细条文略)?
存在较多无用的空行,有些函数过于冗长,可以改进。
4.具体代码部分
(1).有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常?
未对错误信息做处理,检查了返回值。
(2).参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数?
参数传递没有错误,字符串的长度是是字节的长度,从0开始计数。
(3).边界条件是如何处理的?Switch语句的Default是如何处理的?循环有没有可能出现死循环?
for,while循环条件,if判断条件,无Switch语句,矩阵边界是0到8,不会出现死循环。
(4).有没有使用断言(Assert)来保证我们认为不变的条件真的满足?
没有。
(5).对资源的利用,是在哪里申请,在哪里释放的?有没有可能导致资源泄露(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有可能优化?
类对象和函数里在申请,结束调用或函数结束的时候释放。文件打开使用后也关闭了,不会泄露。
(6).数据结构中是否有无用的元素?
没有。
5.效能
(1).代码的效能(Performance)如何?最坏的情况是怎样的?
-c 1000000跑不出来,-s 1000000程序崩溃。
(2).代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中string的操作是否能用StringBuilder 来优化)?
求解数独和自动生成数独中有些函数重复定义,可优化,比如定义方法类。
(3).对于系统和网络调用是否会超时?如何处理?
没有系统和网络调用。
6.可读性
代码可读性如何?有没有足够的注释?
代码可读性一般,函数定义拼音定义大概可知晓用途,但各方面联系有些混乱,建议多加些注释。
7.可测试性
(1).代码是否需要更新或创建新的单元测试?
为进行单元测试,因此需要创建单元测试。
(2).还可以有针对特定领域开发(如数据库、网页、多线程等)的核查表。
没有。
附上Github comment
二、设计一个代码规范
请根据你个人项目使用的语言,尝试使用其中的一款工具,回答以下问题:
(1).工具提供的代码规范和你个人的代码风格有什么不同?
1.tab换成4个空格;
2.{, (, 前应该有空格,//和注释的内容要有一个空格。
3.else要在'}'后,且之间要有一个空格。
4.不能使用 using namespace std。
(2).工具提供的代码规范里有哪些部分是你之前没有想到的?
同一,感觉都没想到。
(3).为什么要这样规范?这样的规范有意义吗?
感觉这样增加代码的可读性,在团队合作中队友在查看代码时更加方便清楚,使合作更加有效,提高团队效率,同时使代码的观赏性也有一定的提高。
结对编程时使用的代码规范
(1).缩进:4个空格
(2).行宽:100字符
(3).在复杂的条件表达式中,用括号清楚地表示逻辑优先级。
(4).断行都用{}并单例一行
(5).可以将多个相同的类型的变量定义在一行。
(6).命名:匈牙利命名法。
(7).函数名第一个字母大写,变量都小写,宏定义都大写。
(8).注释只用ASCII字符,不用中文或特殊字符,函数有写在上一行的注释说明。
(9).不用goto语句。