This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Code Review Agent 代码评审智能体

Code Review Agent 代码评审智能体 是一个基于AI的代码评审工具,使用此工具可以自动生成 Pull Request(PR) 描述,提供代码改进建议,生成Change Logs。支持接入主流Azure DevOps Repos 等主流 Git工具。Code Review Agent会自动对向代码库提交的PR进行检索并自动生成PR描述和代码优化建议等。Code Review Agent为项目经理, 架构师,开发/测试人员提供了对代码库PR的代码检测能力,可以帮助我们快速了解PR到代码库代码的质量,并提供优化建议。

使用流程

创建 PR

Code Review Agent 代码评审智能体 会自动生成PR的标题、类型、摘要和代码变更说明,这些信息将显示在PR的描述中,可以帮助评审者快速了解PR的内容。

  1. 创建Pull Request (PR) 在Azure DevOps上 上创建一个新的Pull Request。

  2. 等待片刻会自动生成PR描述

使用 /review 指令 生成PR评审

  1. 触发代码审查:在PR的评论区输入指令 /review

  2. 等待片刻会自动生成评审内容

使用 /ask 指令对当前PR提问

  1. 提出问题:在PR的评论区输入指令 /ask 问题,后跟具体问题。

  2. 等待片刻会自动生成回复内容

使用 /update_changelog 指令生成变更日志

  1. 生成PR变更日志:在PR的评论区输入指令 /update_changelog

  2. 等待片刻会自动生成变更日志

指令列表

以下指令触发式都是在PR添加评论的试,指令后可以加上具体的参数。

  • /summary 或者 /describe : 生成PR描述,创建PR是会自动生成,也可以手工执行
  • /review:触发代码审查并提供反馈。
  • /ask [问题]:提出具体问题并获取回答。
  • /update_changelog:自动生成并更新变更日志。
  • /improve --pr_code_suggestions.commitable_code_suggestions=true: 生成具体的改进代码,
  • /generate_labels:自动生成标签,并添加到当前PR中
  • /config: 获取工具配置,仅用于Code Review Agent 代码评审智能体的维护
  • /help:获取命令的使用帮助

配置指南

请参考以下链接获取详细的配置指南:配置指南