代码审查的方式
代码审查主要有两种方式:
1. pre-push:在提交合并代码之前,先进行审查,通过和才能合并。这是一种非常严格的审查方式,可以确保每个发布的代码都是已经被审查过的。这种放到在github上维护的开源项目极其合适,代码的所有者可以确保代码是在自己的控制范围。
2. post-push:代码提交后,再审查之前的代码。这是非常宽松的审查方式,审查的效果肯定是打折扣的,但是好处是可以忽略一些不必要的审查以节约时间。其实在国内这种没有太多工程师文化的地方,这种方式是比较好在早期推行的。
Pre-Push规范工具:
阿里出的Java开发手册发布之后,发布了配套的代码检查插件,在Intellj 和 Eclipse中都有。以Intellj 为例,Preferences -> Plugins -> Browse repositories... 搜 Alibaba 即可。安装完成之后需要重启IDE。
插件按照阿里Java开发手册对代码进行校验。
安装完成之后会出现右键菜单:
点击扫描之后的结果是:
在编辑器中也会有直接提示,依据轻重缓急,出现黄色警告或者红色警告,鼠标移动到上面之后,会出现提示信息。点击 more 会有详情,有时候还会有代码样例。
Pose-Push Review工具
这个事情在团队中实行的话,是一定需要有个工具的,相关的工具有很多,审查方式也各有偏重。这里工具主要是解决了这几个问题:
1. 有一个更为直观的界面查看diff。
2. 可以基于工具进行简单的标记和通知,直接把标记写在代码里更利于沟通。
3. 可以知道哪些提交时已经被谁审查过了,方便审查的协作。
这里例举一些,供参考选择。 <