idea代码review工具Code Review Helper使用介绍

简介: CodeReview IDEA 插件是一款用于代码审查的工具,旨在解决在GitLab中查看整体业务逻辑的不便。该插件提供快速添加注释、行号旁的评审意见标记、双击跳转到代码、意见删除和修改、内容导出为Excel以及导入等功能。特别地,它支持离线和在线模式,离线模式下,审核者和开发者通过Excel文件交换评审意见;在线模式则通过服务端实现评审内容的上传和下载,简化文件传输。此外,该插件允许定制评审字段,并能与团队协作工具集成。通过这些特性,CodeReview IDEA 提高了代码审查的效率和便捷性。

 之前在团队里面遇到一个关于代码review的问题,使用gitlab自己的还是facebook的Phabricator,很难看到整体逻辑,因为业务逻辑代码可能不在这次改动范围内,在去源库中找不好找。针对这个刚需,在网上找了一个idea的代码工具CodeReview IDEA 插件:Code Review Helper,它的主要功能有:

  • Alt+A快速添加注释
  • 行号旁边图标标识有检视意见的位置
  • 支持双击评审意见跳转到代码对应位置
  • 支持对评审意见的删除、修改
  • 支持评审意见内容导出为Excel表格
  • 支持将导出的Excel表格中的评审意见导入到IDEA中进行查看与管理。
  • 支持网络交互,适合团队协作场景使用
  • 支持评审字段的自行定制、或者团队统一定制

从功能上看,切实解决了在gitlab中无法快捷方便的看全整体业务的问题。

下来我简单介绍下它的使用。

一、安装Code Review Helper插件

在idea中选择Settings,在下面点击Plugins,在Marketplace里面输入Code Review Helper ,点击安装后重启idea,

image.gif 编辑

如果出现如下界面CodeReview框,点击后出现这样的界面证明安装成功。

image.gif 编辑

二、使用

在安装好之后,我们可以在idea中使用了。

(一)离线版

选中代码内容,然后alt+a可以打开添加评审意见的窗口,在窗口中添加评审信息后点击保存即可完成评审意见的添加,

image.gif 编辑

点击保存后,可以在窗口中看到多了一条数据

image.gif 编辑

并且在工程里面也可以看到,有一个标识,显示此处代码有被审核,鼠标放到黄色标识上,显示审核意见。

image.gif 编辑然后审核人员可以点击列表的Export按钮,导出一个execl,发给写代码的同事,那位同事在idea中点击Import按钮导入后,可以进行建议的确认

image.gif 编辑

image.gif 编辑

image.gif 编辑 导入之后,在列表里面点击列表数据,插件就会自动跳转到具体的文件和行数中,十分方便

image.gif 编辑

image.gif 编辑

之后进行状态的流转,再发回给审核人。

当然这个过程中,在审核人发现自己多加了想删除的需求,那就选择数据进行Delete  Seleted ,要想全删的话,点击Clear  All 就行。

(二)在线版

上述这个虽然很好,但是要一直传文件就是很不方便,所以我咨询了作者 veezean

它主要的功能是简化了上面传文件过程为上传下载,流程改为:

image.gif 编辑

具体步骤如下:

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

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

image.gif 编辑

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

image.gif 编辑

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

image.gif 编辑3.点击提交服务端,可以将本地的评审意见内容提交到服务端(如果有配置webhook通知,会收到相关消息推送)

image.gif 编辑4、选择具体项目以及拉取范围后,点击服务端下载可以从服务端拉取评审意见到本地IDEA中。

比如别人给我提了评审意见,我可以拉取到自己的IDEA中,双击跳转到对应的代码位置,进行问题的确认处理,确认完成后,可以在本地IDEA中对评审意见进行答复,答复完成后提交本地数据到服务端,完成整个review过程的闭环。

但是这个是依赖要建设一个服务端,具体安装教程可以见:

CodeReview IDEA 插件配套服务端使用教程 | Veezean 的小世界 (codingcoder.cn)

在写本次文章的时候,我发现作者在服务端还增加了一些自定义字段等功能,gitee仓库也增加了前端vue的版本:

CodeReviewServer_Portal: CodeReviewServer_Portal (gitee.com),前端的同事有空也可以探索下。

目录
相关文章
|
4天前
|
XML 搜索推荐 JavaScript
Easy Code,IntelliJ IDEA中代码一键生成
Easy Code,IntelliJ IDEA中代码一键生成
105 0
Easy Code,IntelliJ IDEA中代码一键生成
|
4天前
|
数据可视化 Java uml
IDEA中一个被低估的功能,一键把项目代码绘制成UML类图
IDEA中一个被低估的功能,一键把项目代码绘制成UML类图
32 1
|
1天前
|
SQL 关系型数据库 MySQL
实时计算 Flink版产品使用合集之idea本地测试代码,要增大 Flink CDC 在本地 IDEA 测试环境中的内存大小如何解决
实时计算Flink版作为一种强大的流处理和批处理统一的计算框架,广泛应用于各种需要实时数据处理和分析的场景。实时计算Flink版通常结合SQL接口、DataStream API、以及与上下游数据源和存储系统的丰富连接器,提供了一套全面的解决方案,以应对各种实时计算需求。其低延迟、高吞吐、容错性强的特点,使其成为众多企业和组织实时数据处理首选的技术平台。以下是实时计算Flink版的一些典型使用合集。
16 1
|
4天前
|
uml
【经验分享】如何在IDEA中快速学习|审查|复习代码工程?
在IDEA中加速工程学习与审查,提升代码质量和维护性,关键操作包括:使用"Structure"浏览工程结构,通过"Find Usages"查找类、方法或变量引用,借助"Show Local Changes As UML"展示UML图。遵循从整体到局部的UML图学习,再到具体代码的详细探索,可系统理解设计理念。详情参考[IDEA UML教程](https://blog.csdn.net/weixin_44701426/article/details/124598053)。
19 1
【经验分享】如何在IDEA中快速学习|审查|复习代码工程?
|
4天前
|
人工智能 自然语言处理 IDE
如何让阿里云AI001号员工帮我写代码(含IDEA插件使用)
AI 智能时代,将改变所有人的思维方式,学习方式,更注重人的创造力和思考力,如果你懒,你将会被 AI 替代,如果你只想干简单不用动脑的活,你将会被 AI 替代,如果你只会打螺丝,更会被 AI 替代。当下的 AI 人工智能时代,被认为是第四次工业革命的到来,我们更应该看到的是机会,而非跳进焦虑、困惑、悲观的一群人潮中。
|
4天前
|
XML Java 数据格式
idea注释顶格不美观的问题--代码与XML
idea注释顶格不美观的问题--代码与XML
16 6
|
4天前
|
Web App开发 缓存 JavaScript
在IDEA中更改了代码,浏览器中仍运行先前的代码
在IDEA中更改了代码,浏览器中仍运行先前的代码
|
4天前
|
XML SQL 安全
这款 IDEA 插件,检测代码漏洞,一键修复
这款 IDEA 插件,检测代码漏洞,一键修复
62 0
|
4天前
IDEA设置代码自动提示不区分大小写
IDEA设置代码自动提示不区分大小写
82 1
IDEA设置代码自动提示不区分大小写
|
4天前
|
Java
IDEA快捷注释代码//设置不在行首
IDEA快捷注释代码//取消设置在行首
45 0