跳到主要内容

AI 代码检视

AI 代码检视是 AtomGit 平台提供的智能代码检视能力。合并请求创建后可输入 AI 代码检视命令，在数分钟内，AI 自动完成代码分析，生成检视摘要、发现问题并提供可应用的代码建议，让每一次合并更安全、更高效。

核心价值：

  • 分钟级自动检视：合并请求创建后可通过命令触发 AI 自动介入
  • 可应用的代码建议：不仅指出问题，还生成可直接提交的代码修改，点击「应用建议」即可修复
  • 智能检视摘要：自动生成变更摘要，快速了解改动范围与风险等级
  • 安全与质量守护：自动检测安全漏洞、代码异味和最佳实践偏离

1. 工作原理​

流程说明：

  1. 创建合并请求：开发者提交代码变更，创建合并请求
  2. AI 自动检视：Webhook 触发后，AI 在数分钟内完成代码分析
  3. 发布检视结果：AI 在合并请求中发布检视评论，包含摘要、问题和建议
  4. 应用建议：开发者查看建议，点击「应用建议」可直接提交代码修改

2. 核心能力​

2.1 自动检视摘要​

合并请求创建后，AI 自动生成变更摘要，包括：

  • 变更涉及的文件数量和代码行数
  • 改动范围和影响面分析
  • 风险等级评估
  • 主要关注点提示

2.2 代码问题检测​

AI 自动检测以下类型的问题：

类别说明示例
安全风险可能导致安全漏洞的代码密码明文存储、SQL 注入、硬编码密钥
逻辑缺陷可能导致运行时错误的代码空指针引用、资源泄漏、竞态条件
代码质量不符合最佳实践的代码过长函数、重复代码、命名不规范
性能问题可能影响性能的代码N+1 查询、不必要的循环、内存浪费

2.3 可应用的代码建议​

AI 不仅指出问题，还提供可直接提交的代码修改建议：

  • 建议以代码差异格式展示，清晰标注修改内容
  • 开发者可点击「应用建议」直接提交修复代码
  • 应用建议后 AI 会更新检视状态

2.4 交互式检视​

除自动检视外，开发者可在合并请求中通过命令主动请求 AI 协助。

3. 命令参考​

在合并请求的评论区中，使用以下命令与 AI 交互。

3.1 命令列表​

命令说明使用场景
/ai review立即对当前合并请求重新进行一次完整审查（刷新评论）需要重新检视、或自动检视未触发时手动触发
/ai summary仅生成合并请求摘要，不重新审查快速了解变更范围，不需要完整检视
/ai explain对某段代码或评论进行解释不理解 AI 的检视建议，或想了解某段代码的含义
/ai help显示所有可用命令忘记命令用法时查看帮助
@atomgit-bot在评论中直接提问，AI 会回复针对特定问题与 AI 对话，如「这个函数有没有并发问题？」

3.2 使用方式​

  1. 进入已开通 AI 检视的仓库的合并请求页面
  2. 在评论区输入命令（如 /ai review）或 @ 提及（如 @atomgit-bot）
  3. AI 将在数分钟内回复检视结果或回答问题

4. 体验指南​

AI 代码检视目前处于 VIP 尝鲜阶段，采用白名单机制开放体验，目前仅支持公开仓库。

4.1 开通流程​

如果你的组织或仓库尚未开通 AI 代码检视，需要联系 AtomGit 官方团队申请。

步骤说明：

  1. 联系 AtomGit 官方：向 AtomGit 官方团队申请开通 AI 代码检视
  2. 提供信息：告知需要启用检视的组织名称或仓库路径，例如：
    • 组织：openeuler
    • 仓库：openeuler/kernel、cann/ops-nn
  3. 官方配置：AtomGit 官方将组织/仓库加入白名单，并配置 Webhook Token
  4. 开始体验：配置完成后，在已开通的仓库中创建合并请求，使用命令与 AI 交互即可触发 AI 检视

如需为你的组织或仓库开通 AI 代码检视，请联系 AtomGit 官方团队。

4.2 使用限制​

  • AI 代码检视目前仅支持公开仓库
  • 私有仓库支持已在规划中，后续将逐步开放

5. 企业版配置​

企业管理员可以在企业设置中管理 AI 代码检视功能。

5.1 入口位置​

进入 企业设置 → AI Code Review，可查看和管理 AI 代码检视配置。

5.2 配置说明​

配置项说明
启用状态开启或关闭企业的 AI 代码检视功能
仓库范围指定哪些仓库启用 AI 代码检视
检视范围设置对哪些类型的合并请求进行检视（如超过一定行数的 MR）

企业版功能的具体配置选项可能因版本不同而有所差异，请以实际界面为准。

6. 检视结果说明​

6.1 检视评论结构​

AI 在合并请求中发布的检视评论包含以下部分：

检视摘要
├── 变更范围（文件数、代码行数）
├── 风险等级评估
└── 主要关注点

代码问题（按严重程度排列）
├── 安全风险
├── 逻辑缺陷
├── 代码质量
└── 性能问题

代码建议（可应用）
└── 代码差异格式展示

检视结论
└── 整体评价与合并建议

6.2 应用代码建议​

当 AI 提供代码修改建议时：

  1. 查看建议的代码差异，确认修改内容
  2. 点击「应用建议」按钮，AI 将自动提交修复代码
  3. 应用建议后检视状态会更新

7. 联系我们​

如果您在使用过程中遇到任何问题，或有相关意见与建议，欢迎通过官方客服渠道（在线客服、客服邮箱：kefu@gitcode.com、客服热线：4006868951）与我们联系。

8. 常见问题​

Q1：AI 检视需要多长时间？​

通常在合并请求创建后 3-5 分钟内完成检视。大型合并请求（超过 1000 行变更）可能需要更长时间。

Q2：AI 检视的结果准确吗？​

AI 检视基于大语言模型，能够发现大部分常见的代码问题。但 AI 可能产生误报或遗漏，建议将 AI 检视作为辅助工具，仍需人工检视把关。

Q3：AI 检视支持私有仓库吗？​

目前 AI 代码检视仅支持公开仓库，暂不支持私有仓库。后续将逐步开放私有仓库支持。

Q4：可以关闭某个仓库的 AI 检视吗？​

可以。联系 AtomGit 官方移除对应仓库的 Webhook 配置即可关闭。关闭后，该仓库的合并请求将不再触发 AI 检视。企业版下可自行关闭。

Q5：AI 检视支持哪些编程语言？​

目前支持主流编程语言，包括 C/C++、Go、Python、Java、JavaScript/TypeScript、Rust 等。对于不常见的语言，AI 仍可提供基本的代码质量分析。