代码审查
如需完整文档索引,请参阅 llms.txt。文档页面的 Markdown 版本可通过在页面后追加
.md来获取 URL。
使用 ChatGPT 或 Codex 在提交或推送代码前检查代码变更。
在 ChatGPT Work中,上传你想要审查的代码,或通过 已安装的来源 插件提供。在提示词中,注明拉取 请求、分支、提交、文件和审查标准。
在应用中审查
Section titled “在应用中审查”打开审查窗格,了解变更内容,提供具体到行的反馈, 并决定要暂存、还原、提交或推送哪些内容。
若要请求 Codex 审查变更,请在编写器中输入 /review 。选择
对照基准分支审查 或 审查未提交的变更。 Codex 会报告
按优先级排列的发现项,且不会更改你的工作树。
审查窗格要求项目位于 Git 仓库中。如果你的项目 还不是 Git 仓库,应用会提示你创建一个。
输入 /review 以打开 CLI 审查预设。 Codex 会启动一个专用审查器,
读取所选差异并报告按优先级排列、可操作的发现项,
且不会更改你的工作树。
在 /review 中输入 IDE 扩展编写器。选择 对照基准
分支审查 或 审查未提交的变更。 Codex 会报告按优先级排列的发现项,
且不会更改你的工作树。
该 /review 命令仅在打开的项目位于 Git
仓库中时出现。
选择审查范围
Section titled “选择审查范围”在提示词中注明要检查的拉取请求、分支、提交或文件。若要 审查无法通过已安装来源插件访问的本地文件, 请将它们上传到聊天中。
它显示哪些变更
Section titled “它显示哪些变更”审查窗格反映的是你的 Git 仓库状态,而不只是 Codex 编辑的内容。它包括 Codex所做的变更、你自己所做的变更,以及仓库中的任何 其他未提交变更。
默认情况下,审查窗格显示 未暂存 变更。使用 已暂存 查看 Git 索引, 提交 查看所选提交, 分支 查看与你的 基准分支的差异,或使用 上一轮 查看最近一次助手轮次。
选择以下 /review 范围之一:
- 对照基准分支审查 会查找合并基点并审查你的分支差异。
- 审查未提交的变更 包括已暂存、未暂存和未跟踪的文件。
- 审查提交 会审查所选提交的确切变更集。
- 自定义审查说明 会让审查聚焦于你提供的标准。
选择以下 /review 范围之一:
- 对照基准分支审查 会将当前分支与你选择的分支进行比较。
- 审查未提交的变更 会审查你工作树中的变更。
处理审查结果
Section titled “处理审查结果”审查发现项会显示在网页聊天中。你可以要求提供证据,请求一次 范围更窄的后续审查,或要求 ChatGPT 准备修订后的文件。
代码审查结果
Section titled “代码审查结果”审查发现项会在审查窗格中以内联评论形式显示。
默认情况下,审查会在当前聊天中运行。在 设置 > 通用 > 代码审查下,选择 分离 以启动单独的审查聊天。参见 开发者设置。
交互内容: CodexScreenshot 的动态演示请参阅页面顶部的官方原文链接。
审查会作为转录中的一个轮次出现。当你希望审查使用不同于当前 review_model 的
config.toml 会话模型时,请在
中设置。
默认情况下,审查在当前聊天中运行。设置 chatgpt.reviewDelivery 为
detached 当你希望 /review 启动单独的审查聊天时。参见
IDE 扩展设置参考。
如果你要求 ChatGPT 准备修订后的文件,聊天可用的工具和工作区 权限仍然适用。
如果你要求 Codex 应用它发现的修复,你的常规 沙箱和批准 设置 适用。
浏览审查窗格
Section titled “浏览审查窗格”- 点击文件名通常会在你选择的编辑器中打开该文件。你 可以在 开发者设置中选择默认编辑器。
- 点击文件名背景会展开或折叠差异。
- 按住 Cmd 点击某一行,会在你选择的编辑器中打开该行。
- 如果你对某项变更满意,可以 暂存它,或还原 你不想要的变更。
用于反馈的内联评论
Section titled “用于反馈的内联评论”内联评论可让你将反馈直接附加到差异中的特定行。 这通常是引导 Codex 找到正确修复的最快方式。
若要留下内联评论:
- 打开审查窗格。
- 将鼠标悬停在你想评论的行上。
- 选择出现的 + 按钮。
- 写下你的反馈并提交。
- 完成反馈后,向聊天发送一条消息。
由于评论是具体到行的, Codex 可以比使用 一般说明更精确地回应。
Codex 会将内联评论视为审查指导。留下评论后,发送一条 后续消息,明确表达你的意图,例如:“处理 内联评论并保持范围最小。”
拉取请求审查
Section titled “拉取请求审查”当 Codex 具有 GitHub 你仓库的访问权限,且当前项目位于 拉取请求分支上时, ChatGPT 桌面应用可以帮助你在不离开应用的情况下处理拉取 请求反馈。侧边栏会显示拉取请求 上下文和审查者反馈,审查窗格会在 差异旁显示评论,以便你请求 Codex 在同一聊天中处理问题。
安装 GitHub CLI (gh),并使用 gh auth login 进行身份验证,以便 Codex
可以加载拉取请求上下文、审查评论和已变更文件。如果 gh 缺失
或未通过身份验证,拉取请求详情可能不会出现在侧边栏
或审查窗格中。
如果你想将完整修复流程保留在一个地方,请使用此流程:
- 在拉取请求分支上打开审查窗格。
- 查看拉取请求上下文、评论和已变更文件。
- 请求 Codex 修复你想处理的具体评论。
- 在审查窗格中检查生成的差异。
- 准备好后,将变更暂存、提交并推送到拉取请求分支。
对于 GitHub触发的审查,请参见 在 Codex 中使用 GitHub。
暂存和还原文件
Section titled “暂存和还原文件”审查窗格包含 Git 操作,因此你可以在 提交前整理差异。
你可以在以下级别暂存、取消暂存或还原变更:
- 整个差异:使用审查标题中的操作按钮,例如 全部暂存 或 全部还原。
- 按文件:暂存、取消暂存或还原单个文件。
- 按区块:暂存、取消暂存或还原单个区块。
当你想接受部分工作时使用暂存;当你想 丢弃它时使用还原。
已暂存和未暂存状态
Section titled “已暂存和未暂存状态”Git 可以在同一个文件中同时表示已暂存和未暂存的变更。当这种情况 发生时,窗格可以在两个视图中显示同一个文件。这是正常的 Git 行为。