For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主导航

代码审查

在 ChatGPT 和 Codex 客户端中审查代码更改

在提交或推送代码更改之前,使用 ChatGPT 或 Codex 进行检查。

开始审查

在应用中审查

打开审查窗格,了解有哪些更改,针对具体代码行提供反馈, 并决定要暂存、还原、提交或推送哪些内容。

要让 Codex 审查更改,请在编辑器中输入 /review。选择 对照基准分支审查审查未提交的更改。Codex 会报告 按优先级排列的审查结果,且不会更改您的工作树。

审查窗格要求项目位于 Git 代码仓库中。如果您的项目 还不是 Git 代码仓库,应用会提示您创建一个。

选择审查范围

显示哪些更改

审查窗格反映的是您的 Git 代码仓库状态,而不只是 Codex 编辑的内容。其中包括 Codex 所做的更改、您自己所做的更改,以及 代码仓库中任何其他未提交的更改。

默认情况下,审查窗格显示 未暂存 的更改。 已暂存 视图显示 Git 索引, 提交 视图显示所选提交, 分支 视图显示与 基准分支的差异, 上一轮 视图则显示助手最近一轮所做的更改。

审查多个代码仓库

本地项目包含多个文件夹, 且这些文件夹分属不同的 Git 代码仓库时,审查窗格可显示每个 代码仓库中的更改。在审查标题栏中打开代码仓库选择器,即可检查 另一个代码仓库,并查看其中添加或删除的代码行,而无需离开 当前审查窗格。

选择 上一轮 ,即可查看助手在所有关联的 代码仓库中所做的最新更改。该视图的代码仓库选择器会显示 所有代码仓库 。其他 审查范围,如 未暂存已暂存分支,适用于您所选择的 代码仓库。

处理审查结果

代码审查结果

审查发现的问题会以内联评论的形式显示在审查窗格中。

默认情况下,审查会在当前聊天中运行。在 设置 > 常规 > 代码审查下,选择 独立 以启动单独的审查聊天。请参阅 开发者设置

如果您让 Codex 应用它提出的修复方案,您原有的沙盒和审批 设置仍然适用。

浏览审查窗格

  • 点击文件名通常会在您选择的编辑器中打开该文件。您 可以在开发者设置中选择默认编辑器。
  • 点击文件名所在的背景区域可展开或折叠差异。
  • 按住 Cmd 键并点击某一行,即可在您选择的编辑器中打开该行。
  • 如果您对某项更改满意,可以将其暂存,或还原不需要的更改

使用内联评论提供反馈

内联评论可让您将反馈直接附加到差异中的具体代码行。 这通常是引导 Codex 正确修复问题的最快方法。

要留下内联评论:

  1. 打开审查窗格。
  2. 将鼠标悬停在您要评论的代码行上。
  3. 选择随即出现的 + 按钮。
  4. 填写您的反馈并提交。
  5. 完成反馈后,向聊天发送一条消息。

由于评论对应具体代码行,与收到笼统的 指令相比,Codex 能作出更精准的回应。

Codex 会将内联评论视为审查指导。留下评论后,请发送一条 后续消息,明确说明您的意图,例如:“处理 内联评论,并尽量缩小改动范围。”

Pull Request 审查

当 Codex 拥有您代码仓库的 GitHub 访问权限,且当前项目位于 Pull Request 分支上时,ChatGPT 桌面应用可以帮助您在应用内处理 Pull Request 反馈。侧边栏会显示 Pull Request 上下文和审查者的反馈,审查窗格则会将评论与差异一并显示, 以便您在同一聊天中要求 Codex 解决相关问题。

安装 GitHub CLI(gh),并使用 gh auth login 完成身份验证,以便 Codex 加载 Pull Request 上下文、审查评论和已更改的文件。如果 gh 未安装或未通过身份验证,Pull Request 详情可能不会显示在侧边栏 或审查窗格中。

如果您希望在同一处完成整个修复流程,请按以下步骤操作:

  1. 在 Pull Request 分支上打开审查窗格。
  2. 查看 Pull Request 上下文、评论和已更改的文件。
  3. 请 Codex 针对您希望处理的具体评论进行修复。
  4. 在审查窗格中检查生成的差异。
  5. 准备就绪后,将更改暂存、提交并推送到 Pull Request 分支。

有关 GitHub 触发的审查,请参阅在 GitHub 中使用 Codex

暂存和还原文件

审查窗格包含 Git 操作,您可以在提交之前调整差异内容。

您可以按以下层级暂存、取消暂存或还原更改:

  • 整个差异:使用审查窗格标题栏中的操作按钮,例如 全部暂存全部还原
  • 按文件:暂存、取消暂存或还原单个文件。
  • 按变更块:暂存、取消暂存或还原单个变更块。

如果您想接受部分工作成果,请将其暂存;如果想要舍弃这些成果,请将其还原。

已暂存和未暂存状态

在 Git 中,同一文件可以同时包含已暂存和未暂存的更改。出现这种情况时,窗格可能会在两个视图中都显示同一文件。这是 Git 的正常行为。