Code Review

Code Review 是一个用于知晓同伴工作、协调工作进度、讲解代码逻辑,从而提高团队成员技术水平,统一团队代码风格,避免因代码引发的线上问题、交付可靠的软件应用程序等诸多好处的软件开发辅助活动。


Code Review工具

Code Review 工具自动化了代码审核过程,它们有助于静态代码分析,这对于交付可靠的软件应用程序至关重要。

1 Phabricator
Phabricator 是一个开源的源码扫描程序。它还包括了基于 Web 的轻量级代码审查、规划、测试、bug 发现等功能。
主要特性:
提交前(Pre-Commit)的代码审查可以跟踪大量的 bug可以帮助我们为每个部门构建独立的任务表单可定制任务管理允许我们编写有用的注释和备注信息。
下载链接:
https://www.phacility.com/

2 Barkeep
Barkeep 是一个友好的代码审查系统工具。它提供了一种最简单的方法来审查代码。它允许我们查看任何 Git 库的提交、查看差异点并编写注释。
主要特性:
该工具允许我们发送电子邮件给相关的提交者支持提交后(post-commit)的工作流提供了干净的用户界面,易于浏览。
下载链接:
http://getbarkeep.org/

3 Reviewable
Reviewable 是一个轻量级的、功能强大的代码分析工具,它使代码审查更快、更全面。它通过用户界面清理、bug 发现以及语法高亮显示来帮助我们提高代码质量。
主要特性:
完全可定制的逻辑可以帮助我们确定何时能完成审查仅适用于 GitHub 和 GitHub Enterprise,可与它们进行无缝集成,最小化管理工作行注释可以跨文件版本进行映射,并会一直保留到问题解决为止可以帮助我们完整地跟踪审查人(每个文件的每个修改版本都是谁审查的),以确保没有遗漏任何变更。
下载链接:
https://reviewable.io/

4 Peer Review Plugin

Peer Review Plugin 消除了耗时的代码审查会议的需求,因为它使我们可以在基于 Web 的用户友好的环境中审查代码。
主要特性:
改善的知识转移体验可以帮助我们审查存储库中的文件并对其进行注释以 MS Word docx 格式导出数据更好的代码以及更少的缺陷支持 Git、SVN 和 GitHub.
下载链接:
https://trac-hacks.org/wiki/PeerReviewPlugin

5 JArchitect
JArchitect 是一款易于使用的代码审查工具,可用于分析 Java 代码。每次审查后,它都会发送一份项目开发相关的报告。该工具还可以帮助我们提高代码的可维护性。
主要特性:
JArchitect 代码规则是 LINQ 查询,可以在第二个查询中生成JArchitect 可以帮助我们发现数百个甚至数千个影响实际代码库的问题当发现新问题时,它会立即通知开发人员。
下载链接:
http://www.jarchitect.com/

代码审查流程
自动化检查

自动化检查,一般为应用负责人在本地对整个项目进行静态检查。
Ali-check

人工审核

人工审核一般在上线前,结合发布平台,在发布前进行人工审核。

代码评审会
  • 功能讲解
    简要介绍功能,
  • 技术讲解
    1 技术分享
    新技术点的分享
    2 技术难点讨论
    对之后的工作,如果有技术上的难点可以和大家探讨交流。
  • 技术评审
    针对代码中的问题 进行分析和讲解, 如果能带出一些知识点来, 可以进行展开。
  • 评审标准
    1 代码可读性
    保证发布的代码和评审意见的可读性。提交代码的时候,在符合团队风格的同时,把代码弄的好看点,如果你明确自己这个代码哪个地方不足,Highlight 出来让大家给意见。
    2 逻辑合理性
    没有逻辑错误,符合功能要求
    3 代码精简化
    重心是优化代码,改善和保证代码质量

如果你希望能找到一个适合自己团队的review工具,可以参考其他大佬做过的工具介绍比较详细:
https://jingyan.baidu.com/article/da1091fb1174bf027849d696.html
https://zhuanlan.zhihu.com/p/103592147?utm_source=wechat_session

你可能感兴趣的:(Code Review)