一种更简单高效的代码review体验

在我们的项目开发过程中，代码review是不可或缺的一个环节。虽然市面上已有一些成熟的代码review系统，或者是基于git提交记录进行的在线review操作，也许其功能更强大，但是使用上总是不够方便：

  • 代码不同于小说审稿，纯文本类型的阅读式review模式，很难发现逻辑层面的问题
  • 代码review完成之后，针对评审意见的逐个确认、跟踪闭环也比较麻烦
  • 平时项目开发的时候没法同步记录发现的问题
  • …

对于程序员来说，IDEA中查看代码才是最佳模式，在IDEA中可以跳转、搜索、分析调用，然后才能检视出深层的代码逻辑问题。此外，平时开发过程中，如果写代码的时候发现一些问题点，如果可以直接在IDEA中记录下来，然后交由对应责任人去修改，这样的代码review体验岂不是更方便、更高效。

基于此想法，利用业余时间开发了IDEA配套的代码review插件，上到应用市场之后，也收获了相对比较高的评分，也收到很多同学的私信赞扬，说明程序员“苦code review久矣”！

当然，随着使用的同学数量增加，也收到越来越多的同学反馈希望加一个团队协作能力，这样可以方便团队内评审活动的开展。

于是，在原有的本地review功能基础上，增加了插件配套的服务端交互能力，这样就实现了团队内成员间代码review意见的管理、统计以及彼此的协同。团队协同版本的交互逻辑如下示意：

基本使用方法

  1. 选中代码内容，然后alt+a可以打开添加评审意见的窗口，在窗口中添加评审信息后点击保存即可完成评审意见的添加。或者选中代码之后，鼠标右键，也可以弹出添加评审意见的弹窗。

  1. 按住alt按钮，并点击对应记录，可以弹出确认窗口，可以对别人提的评审意见进行确认。

  1. 双击评审意见表格中黄色的区域，可以直接在表格中修改对应字段的值；双击评审意见表格中白色区域，可以直接跳转到评审意见对应的代码位置

  2. 代码中被提过评审意见的地方，代码行号旁边会有对应标识提醒，并且会根据评审意见状态，显示不同颜色的划线标记（如果不想要划线标记，可以再设置界面关闭）

  1. 本地评审数据导出到Excel表格中，以及将本地Excel表格中内容导入到IDEA中，方便在IDEA中进行跳转查看意见内容

  1. 自定义评审字段的内容。

V4.0.1开始支持评审字段内容的自定义能力，在设置中可以进行调整，定制符合您实际诉求的评审字段内容。

在字段自定义的界面中，对配置文件进行修改，增加或者删除字段值，修改完成之后点击保存即可。

  1. 在IDEA中评审意见表格中右键，提供一些常见的右键菜单，可以基于右键菜单快捷的对已有评审意见进行操作。

  1. 在IDEA评审意见列表界面，选择某条记录，右键快照查看， 可以查看评审意见提交时的原始文件内容快照，便于和改动后的代码进行对照比较。

重要
配置操作前，请先了解下配置字段中每个字段的具体含义，以免配置错误影响插件功能。具体说明，可以点此了解

如果配置错误导致插件功能出现问题，您可以点击配置界面左下角的恢复默认配置按钮，恢复到插件默认状态，然后重新去修改配置即可。

网络版本使用方式

  1. 打开idea插件界面进行网络版本配置：

点击settings按钮，打开设置界面，可以切换界面中英文显示，然后切换到网络版本：

在网络版本中，输入搭建好的服务端地址，点击连接测试成功后，再输入账号和密码，点击登录测试,验证成功后即可点击下方的保存按钮。

  1. 设置完成后，会自动从服务端拉取已经配置好的评审字段配置信息、以及服务端的项目信息列表等。使用过程中用户也可以手动点击同步配置按钮，从服务端拉取最新的配置信息。

  1. 点击提交服务端，可以将本地的评审意见内容提交到服务端（如果有配置webhook通知，会收到相关消息推送）

  1. 选择具体项目以及拉取范围后，点击服务端下载可以从服务端拉取评审意见到本地IDEA中。比如别人给我提了评审意见，我可以拉取到自己的IDEA中，双击跳转到对应的代码位置，进行问题的确认处理，确认完成后，可以在本地IDEA中对评审意见进行答复，答复完成后提交本地数据到服务端，完成整个review过程的闭环。

自定义字段配置

点此查看

服务端部署与使用介绍

如果您需要在团队中来使用本插件，您可以选择部署配套的服务端，来实现团队成员之间的协同配合。具体部署方式，可以参见下面教程。

点此查看

问题&建议

使用过程中，如果发现有bug或者有功能建议，欢迎提issue单，或者通过公众号是vzn呀联系到作者，获取更为及时的支持。

当然，如果觉得本软件帮助到了您的工作，也欢迎支持我继续更新维护下去~

期待与你一起探讨，一起成长为更好的自己。