本节书摘来自异步社区《众妙之门——JavaScript与jQuery技术精粹》一书中的第2章,第2.4节,作者: 【德】Smashing Magazine译者: 吴达茄 芮鹏飞 更多章节内容可以访问云栖社区“异步社区”公众号查看。
2.4 进行代码复查的人员需要提供的信息
Google前开发人员Jonathan Betz曾经提到过对别人进行代码复查时应该提供的六样东西:
1.正确性
代码能实现所有它声明的功能吗?
2.复杂性
代码是否直接完成了其功能?
3.一致性
它是否与目标一致?
4.可维护性
团队内其他人员付出一定合理水平的努力时是否可以较容易地拓展代码?
5.可扩缩性
代码是否是按照对100个或者10000个用户同样工作的原则来书写的?它是最优的吗?
6.风格
代码是否按某一特定风格编写的(最好是按照团队统一的风格)?
我赞同以上六点,并将它扩展成复查者在实际操作中可以遵循的行动手册。所以,复查者应该做到以下几点:
. 提供清晰的评论、依据并保持良好的沟通。
. 提出可实现的不足之处(不要批评过度)。
. 指出为什么某种方法不推荐,如果可能的话,给出博客、帖子、要点、说明、MDN页和jsPe rf测试来支持你的观点。
. 给出替代解决方案,或是用一个单独的可运行格式,或是通过fork整合在代码中,方便开发者清晰地看到它们错误的地方。
. 首先关注解决方案,其次看编程风格。对于编程风格的建议可以放在复查的后面,但是在关注这个之前首先要找出根本的问题。
. 复查要求外的部分,这完全由复查者自己决定,但是如果我发现开发者其他方面的问题,我一般会建议他们如何改进。到目前为止我还没收到过关于这方面的抱怨,所以我认为这并不是一件坏事。