[我的总结]Code Review

是什么

代码审查（英语：Code review）是指对计算机源代码系统化地审查，经常使用软件同行评审的方式进行，其目的是在找出及修正在软件开发初期未发现的错误，提高软件质量及开发者的技术。代码审查常以不一样的形式进行，例如结对编程、非正式的看过整个代码，或是正式的软件检查。

——维基百科

为何

1. 提早发现代码中的潜在错误。当咱们修改较大量的代码时，一般会遗漏一些细节。Code Review能够更好的帮助咱们发现潜在的问题，同时以更低的成本进行修复。

2. 分享知识。在Code Review中，知识的分享一般是双向的。咱们能够经过阅读别人的代码或者其余人提的Comments学到东西。尤为是后者每每可以给咱们带来更多的帮助。由于今天别人的错误，可能明天咱们就会犯。其次，咱们能够经过给出comments来向其余人分享咱们的知识。若是这些知识并不彻底正确，你们能够在讨论的过程当中有更大的获益。

3. 使整个组了解彼此的工做。人们能够经过review其余人的代码及时的了解到其余人的进度。

个人经验与教训
在这方面，我犯了几个错误：

1. 在刚开始的时候，碰到别人给我作code review，对于不少comments我都是抱着很感谢的态度，可是对于一些comments则不觉得然。可是其实，人家只是从不一样的角度看待code。好比，某个地方有两种写法，人家建议你采用其中的某一种的缘由并非另一种不行，而是为了保持一致的编码风格，或者遵循一些准则。这种时候，大能够走过去问问为何，而后共同决定采起什么样的action。
2. 不敢给别人提comments。不少时候，对于能够提出来，也能够不提的东西，我就放过了。可是其实，若是我提出来，可能会让本身和同事从讨论中学到更多东西，甚至我以为的这个点是个人一个误区，能够经过这个机会纠正。
3. 没有及时的作code review。随着团队转型，总体工做节奏不断提升，不少时候会专心在本身的事情上而忽视了code review。可是其实不管从我的仍是团队的角度，code review的ROI（Return On Investment）都至关高。对于团队的好处不言而喻，对于我的而言，及时的code review每每可以帮咱们树立更好的名声，至少在咱们须要他人帮咱们作code review的时候会更容易地得到帮助。

从过去一段时间的实际工做中，我以为从code review的发起者这边，咱们能够：

1. 在别人可能有疑问的地方，把本身的想法写成注释。这样不止是此次code review的人，之后看你代码的人也能知道为何。这个别人颇有可能就是几个月以后的本身。

2. 发code review以前，本身先完整的看一遍。把一些可能犯错的模式再检查一遍。

3. 邀请最小必要集来进行code review。邀请的人越多，会take action的人越少……

从reviewer的角度来讲，咱们能够：

1. 及时的完成code review
2. 不要惧怕给comments或者sign-off
3. 除了看代码自己，还应该从其余人的comments中汲取精华
4. 要确定对方写的好的地方