个人作业Week2-代码复审（修改明确了要求）

代码复审

零，说在前面的话

大家完成了个人项目之后，都写了很多代码。
这些代码可能：

• 大括号换行/不换行
• 使用tab缩进/使用空格缩进
• 变量名函数名的定义很好/不好
• 每个函数都有详细的注释解释函数的功能与目的/没有
• 整个代码的结构清晰、功能明确/不清晰、不明确
• ……

甚至：

• 会崩溃
• 有内存泄漏
• ……

那么请看：

一、代码复审Check List

请看书本第四章《两人合作》的部分。
或链接：现代软件工程讲义 3 代码规范与代码复审

为了提高同学们的代码质量，那么请每位同学复审结对编程的伙伴的个人项目，针对下方的Checklist中的内容，对对方的代码进行复审，并完成一个个人博客报告复审结果。

1.概要部分

• 代码能符合需求和规格说明么？
• 代码设计是否有周全的考虑？
• 代码可读性如何？
• 代码容易维护么？
• 代码的每一行都执行并检查过了吗？

2.设计规范部分

• 设计是否遵从已知的设计模式或项目中常用的模式？
• 有没有硬编码或字符串/数字等存在？
• 代码有没有依赖于某一平台，是否会影响将来的移植（如Win32到Win64）？
• 开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现？在本项目中是否存在类似的功能可以调用而不用全部重新实现？
• 有没有无用的代码可以清除？（很多人想保留尽可能多的代码，因为以后可能会用上，这样导致程序文件中有很多注释掉的代码，这些代码都可以删除，因为源代码控制已经保存了原来的老代码。）

3.代码规范部分

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

4.具体代码部分

• 有没有对错误进行处理？对于调用的外部函数，是否检查了返回值或处理了异常？
• 参数传递有无错误，字符串的长度是字节的长度还是字符（可能是单/双字节）的长度，是以0开始计数还是以1开始计数？
• 边界条件是如何处理的？Switch语句的Default是如何处理的？循环有没有可能出现死循环？
• 有没有使用断言（Assert）来保证我们认为不变的条件真的满足？
• 对资源的利用，是在哪里申请，在哪里释放的？有没有可能导致资源泄露（内存、文件、各种GUI资源、数据库访问的连接，等等）？有没有可能优化？
• 数据结构中是否有无用的元素？

5.效能

• 代码的效能（Performance）如何？最坏的情况是怎样的？
• 代码中，特别是循环中是否有明显可优化的部分（C++中反复创建类，C#中string的操作是否能用StringBuilder 来优化）？
• 对于系统和网络调用是否会超时？如何处理?

6.可读性

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

7.可测试性

• 代码是否需要更新或创建新的单元测试？
• 还可以有针对特定领域开发（如数据库、网页、多线程等）的核查表。

二、设计一个代码规范

这次同学们的作业都是用C++/C#完成的，这里提供了C++/C#的几个代码规范工具：

StyleCop
这里有一个学习笔记汇总：
StyleCop学习笔记——初识StyleCop
StyleCop学习笔记——默认的规则
StyleCop学习笔记——自定义规则

Cpplint
cpplint 1.3.0

请根据你个人项目使用的语言，尝试使用其中的一款工具，回答以下问题：

• 工具提供的代码规范和你个人的代码风格有什么不同？
• 工具提供的代码规范里有哪些部分是你之前没有想到的？
• 为什么要这样规范？这样的规范有意义吗？

最后，请根据构建之法书上编码规范里提到的那些要点整理一份你们在结对编程时使用的代码规范。

三、要求：

1.对结对搭档的每一次commit的内容都要进行复审
2.代码复审须有多种形式：

• 两人在某一地点当面复审
• 两人进行代码的远程复审
  • 请使用Github中的issue功能提出代码的问题，被复审方给出回答并对代码进行修改

3.CheckList中与某段代码密切相关的复审问题请直接使用github的comment功能进行点评，并在博客中CheckList的相应部分附上comment的链接；总结性的问题书写在博客里
4.将一二部分写成一个博客