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

Codex use case

重构您的代码库

在不改变行为的前提下移除死代码,并对遗留模式进行现代化改造。

Difficulty 高级
Time horizon 1 小时

使用 Codex,以便于审查的小步迭代移除死代码、梳理大型文件、合并重复逻辑,并对过时模式进行现代化改造。

最适合

  • 存在死代码、过大模块、重复逻辑或过时抽象,导致日常修改成本高昂的代码库。
  • 需要就地进行代码现代化改造,同时不希望这项工作演变成框架或技术栈迁移的团队。

Contents

    ← 全部使用场景

    重构您的代码库

    在不改变行为的前提下移除死代码,并对遗留模式进行现代化改造。

    使用 Codex,以便于审查的小步迭代移除死代码、梳理大型文件、合并重复逻辑,并对过时模式进行现代化改造。

    高级
    1 小时

    使用 Codex,以便于审查的小步迭代移除死代码、梳理大型文件、合并重复逻辑,并对过时模式进行现代化改造。

    高级
    1 小时

    最适合

    • 存在死代码、过大模块、重复逻辑或过时抽象,导致日常修改成本高昂的代码库。
    • 需要就地进行代码现代化改造,同时不希望这项工作演变成框架或技术栈迁移的团队。

    技能与插件

    • 在合并一轮现代化改造的变更前,审查安全敏感的清理操作、依赖项变更、身份验证流程和对外暴露面。
    • 将行之有效的现代化改造模式、审查清单或一致性验证工作流转化为可复用的代码仓库或团队技能。
    Skill Why use it
    Security Best Practices 在合并一轮现代化改造的变更前,审查安全敏感的清理操作、依赖项变更、身份验证流程和对外暴露面。
    Skill Creator 将行之有效的现代化改造模式、审查清单或一致性验证工作流转化为可复用的代码仓库或团队技能。

    入门提示

    对此代码库进行现代化改造和重构。 要求: - 除非我明确要求进行功能变更,否则请保持行为不变。 - 首先找出死代码、重复的代码路径、过大模块、过时抽象,以及导致变更缓慢的遗留模式。 - 对于拟议的每一轮重构,请说明当前行为、结构改进,以及应能证明行为保持稳定的验证检查。 - 将工作拆分为多个便于审查的小步重构,例如删除死代码、简化控制流、提取辅助函数,或使用代码仓库当前的约定替换过时模式。 - 除非重构需要变更公共 API,否则请保持其稳定。 - 明确指出任何应拆分为单独迁移任务的框架迁移、依赖项升级、API 变更或架构调整。 - 如果工作范围较广,请提出我们应在实施前创建的文档、规范和一致性检查。 请提出完成上述工作的计划。
    对此代码库进行现代化改造和重构。 要求: - 除非我明确要求进行功能变更,否则请保持行为不变。 - 首先找出死代码、重复的代码路径、过大模块、过时抽象,以及导致变更缓慢的遗留模式。 - 对于拟议的每一轮重构,请说明当前行为、结构改进,以及应能证明行为保持稳定的验证检查。 - 将工作拆分为多个便于审查的小步重构,例如删除死代码、简化控制流、提取辅助函数,或使用代码仓库当前的约定替换过时模式。 - 除非重构需要变更公共 API,否则请保持其稳定。 - 明确指出任何应拆分为单独迁移任务的框架迁移、依赖项升级、API 变更或架构调整。 - 如果工作范围较广,请提出我们应在实施前创建的文档、规范和一致性检查。 请提出完成上述工作的计划。

    简介

    如果您的代码库中积累了未使用的代码、重复逻辑、过时抽象、大型文件或遗留模式,导致每次修改的成本都高于应有水平,就应考虑通过重构来减少技术债务。重构旨在改善现有系统的结构,而不是让这项工作演变为技术栈迁移。

    Codex 在这里很有帮助,因为它可以先梳理混乱区域的整体情况,再将清理工作拆分成便于审查的小步骤逐步落实:删除未使用的代码路径、理顺大型模块、合并重复的代码路径、更新旧有框架模式,并加强每一步的验证。

    目标是就地改进当前代码库:

    1. 移除未使用的代码、过时的辅助代码、旧标志,以及不再需要的兼容性适配层。
    2. 通过提取辅助函数、拆分组件或将副作用移至更清晰的边界,精简冗杂的模块。
    3. 用代码仓库当前的约定替换遗留模式:采用较新的框架原语、更清晰的类型、更简单的状态流转或标准库工具。
    4. 在保持对外行为稳定的同时,降低下一次修改的成本。

    使用方法

    1. 在编辑前,先让 Codex 梳理该区域的整体情况,包括冗杂模块、重复逻辑、未使用的代码、测试、对外契约,以及代码仓库已不再适用的旧模式。
    2. 每次只选择一个清理主题:移除未使用的代码、简化控制流、对过时模式进行现代化改造,或将大型文件拆分成职责归属明确的较小部分。
    3. 在 Codex 修改文件前,让它先说明当前行为、拟进行的结构改进,以及足以证明行为保持稳定的最小范围检查。
    4. 每一轮完成后,都进行审查并运行最小且有效的检查,而不要把整个清理工作一次性合并到一个变更中。
    5. 除非这些改动是完成清理所必需的,否则请将技术栈变更、依赖项迁移和架构调整分别作为单独任务处理。

    您可以使用计划模式为重构制定计划,然后再开始这项 工作。

    利用 ExecPlans

    这份 代码现代化改造实践指南 介绍了 ExecPlans:这类文档可让 Codex 维护清理工作的整体概览、明确说明预期最终状态,并记录每一轮完成后的验证结果。 当重构横跨多个模块或需要多个会话才能完成时,这类文档很有用。您可以用它们记录删除项、模式更新、必须保持稳定的契约,以及仍待后续处理的事项。

    针对重复出现的模式使用技能

    技能 在相同的清理规则反复用于多个代码仓库、服务或团队时很有用。有可用的框架专用技能时,请使用它们;对于风险较高的清理,请搭配使用安全和 CI 技能;如果您已有一份经过验证的清单,用于移除未使用的代码、提取模块或对遗留模式进行现代化改造,请创建团队技能。 如果您最终需要在多个代码库中执行同样的现代化改造,Codex 可以帮助您将首次成功的改造转化为可复用的技能。

    相关使用场景