软件工程第二次作业(代码复审)

软件工程第二次作业(代码复审)

1.概要部分

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

　　　　代码能符合需求和规格说明，且有一定健壮性。

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

　　　　考虑相对周全，不过解数独中无法过滤掉读入文件中的非法字符

　　代码可读性如何？

　　　　函数较短，可读性极好

　　代码容易维护么？

　　　　因为可读性好，所以代码容易维护

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

　　　　代码每一行均执行，无冗余代码

2.设计规范

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

　　　　没有用到设计模式

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

　　　　存在硬编码

　　　　　虽然这定义了一个宏，但是后面的代码中没有用到，循环分支语句中用到较多常数来控制

　　　　

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

　　　　不依赖于平台

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

　　　　没有使用相关功能

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

　　　　没有，上面提到的那个宏虽然没有用到，但是需要用来解决提到的硬编码问题

3.代码规范

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

　　　　大体符合，不过细微之处存在少量无意义空行

4.具体代码部分

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

　　　　有对错误进行处理，对调用的外部函数均检查了返回值

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

　　　　参数传递无错误，字符串的长度是以单字节为单位，是以0开始计数

　　边界条件是如何处理的？Switch语句的Default是如何处理的？循环有没有可能出现死循环？

　　　　所有循环均用for循环中的i<9和i<8来控制边界条件，不存在死循环，没有switch语句。

　　有没有使用断言（Assert）来保证我们认为不变的条件真的满足？

　　　　没有使用断言

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

　　　　对资源的动态利用是在CreateArray()中申请，在DeleteArray(int **a)中释放，目前没有发现资源泄露的问题，优化的方式是一些标志位可以采用位图法，这样能让资源更紧凑

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

　　　　数据结构中不存在无用的元素

5.效能

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

　　　　代码效能巨好，-c 1000000只需1.203秒，-s 1000000只需38.903秒，比我的快出20%

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

　　　　没有明显可优化的部分

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

　　　　没有系统和网络调用

6.可读性

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

　　　　代码可读性很好，虽然没有注释，但是逻辑、变量名很清晰，很容易看懂

7.可测试性

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

　　　　代码已经有较为完善的单元测试，暂时不需要更新

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

　　　　没有相关拓展功能的使用

8.评论链接

　　 https://github.com/ErisPluto/Sudoku/issues/1

　　https://github.com/ErisPluto/Sudoku/issues/2

 

代码规范：

 　　Cpplint:

　　　　由于我使用的是VS2017，因此不兼容StyleCop，所以我采用cpplint

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

　　　　这个工具的代码规范，我发现无时无刻都在使用空格，由于我习惯用tab来缩进，所以我报了1477个错误

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

　　　　没有想到的就是这个规范里面要用空格来取代tab，且注释双斜杠后面要加空格

　　　　'{'放置在前置语句的句末，而不是单起一行

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

　　　　我认为在一些特定的场景下有意义，比如说双斜杠后面加空格能让注释看的更加清晰

　　　　用空格取代tab可以避免tab在不同的环境下出现不同的长度的问题

　　　　不过我认为'{'放置在前置语句的句末没有意义，单起一行看着更清晰

 

　　结对编程时的代码规范：

　　　　　变量名尽量取的有意义

　　　　　单个函数长度尽量控制在100行以内

　　　　　一个函数一个功能，函数名说明功能

　　　　　分支，循环语句要有缩进

　　　　　在逻辑比较复杂的地方要写注释

　　　　　函数中如果出现异常情况，将异常放到返回值中进行处理

　　　　　大括号单起一行

　　　　　尽量减少硬编码，将固定的数字用宏代替，增加可拓展性和可读性

　　　　　变量命名用下划线法，函数命名用驼峰法

posted on 2017-10-03 03:59  永远与须臾的罪袋 阅读( ...) 评论( ...) 编辑 收藏

转载于:https://www.cnblogs.com/514DNA/p/7623090.html