如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题
Codex

Codex 使用场景

读懂大型代码库

追踪请求的处理流程,梳理陌生模块的结构,快速找到相关文件。

难度 Easy
时间跨度 5m

让 Codex 帮您梳理陌生代码库的结构,解释各模块的职责和数据流向,并指出修改代码前值得先读哪些文件。

最适合

  • 正在熟悉新代码仓库或服务的新工程师
  • 希望在修改某项功能前先了解其工作原理的人

目录

    ← 所有使用场景

    读懂大型代码库

    追踪请求的处理流程,梳理陌生模块的结构,快速找到相关文件。

    让 Codex 帮您梳理陌生代码库的结构,解释各模块的职责和数据流向,并指出修改代码前值得先读哪些文件。

    Easy
    5m

    让 Codex 帮您梳理陌生代码库的结构,解释各模块的职责和数据流向,并指出修改代码前值得先读哪些文件。

    Easy
    5m

    最适合

    • 正在熟悉新代码仓库或服务的新工程师
    • 希望在修改某项功能前先了解其工作原理的人

    起始提示词

    请结合代码库,说明请求在 <name of the system area> 中的处理流程。 请说明以下几点: - 各模块分别负责什么 - 代码在哪里验证数据 - 修改代码前最需要留意哪些容易出错的地方 最后,请列出我接下来应该阅读的文件。
    请结合代码库,说明请求在 <name of the system area> 中的处理流程。 请说明以下几点: - 各模块分别负责什么 - 代码在哪里验证数据 - 修改代码前最需要留意哪些容易出错的地方 最后,请列出我接下来应该阅读的文件。

    简介

    如果您刚接触一个代码仓库,或临时接手一项不熟悉的功能,Codex 可以帮您在动手改代码前理清思路。除了了解整体情况,您还需要梳理请求的处理流程,弄清各模块的职责,并找出接下来值得阅读的文件。

    使用方法

    如果您刚接触一个项目,可以先请 Codex 介绍整个代码库:

    请给我介绍一下这个代码仓库。

    如果您要为现有代码库添加新功能,可以请 Codex 讲解系统中与该功能相关的部分。您把范围界定得越清楚,Codex 的讲解就越具体:

    1. 向 Codex 提供相关文件、目录,或指明您想了解的功能。
    2. 请 Codex 追踪请求的处理流程,并说明哪些模块分别负责业务逻辑、传输、持久化和用户界面。
    3. 在修改任何代码之前,先问清楚哪些环节会执行校验、产生副作用或触发状态转换。
    4. 最后,询问接下来应该阅读哪些文件,以及哪些地方改起来有风险。

    有帮助的入门讲解应当让您看清请求如何在各模块之间流转,仅列出文件名还不够。在您动手修改代码之前,Codex 应该已经讲清主要流程,指出风险所在,并告诉您接下来值得阅读哪些文件、需要做哪些检查。

    可以继续追问的问题

    看完 Codex 的初步讲解后,您可以继续追问,直到您对细节有足够的了解,有把握做出第一处修改。有效的追问通常能让 Codex 说明代码依赖哪些假设、有哪些不明显的依赖关系,以及修改后需要做哪些检查。

    • 哪个模块负责实际的业务逻辑?哪些模块负责传输层或界面层?
    • 在哪个环节执行校验?这些校验确保哪些前提条件成立?
    • 如果我修改这个流程,哪些相关文件或后台任务容易被忽略?
    • 修改这部分代码后,我应该运行哪些测试或检查?

    相关使用场景