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. 每輪完成後都應審查並執行最小但有效的檢查,而不是將整項清理作業集中在單一 diff 中。
    5. 除非完成清理必須進行這些變更,否則請將技術堆疊變更、相依套件遷移與架構調整分別列為獨立任務。

    可使用規劃模式,在開始這項 工作前建立重構計畫。

    善用 ExecPlans

    這份 程式碼現代化實務指南 介紹了 ExecPlans:這類文件可讓 Codex 持續掌握清理工作的全貌、清楚列明預期的最終狀態,並記錄每一輪完成後的驗證結果。 當重構涵蓋多個模組或需要多個工作階段才能完成時,這類文件特別有用。可用它們記錄刪除項目、模式更新、必須維持穩定的契約,以及仍暫緩處理的項目。

    運用技能重複套用既有模式

    技能 適合用於需要在不同程式碼庫、服務或團隊間重複套用相同清理規則的情況。有可用的框架專屬技能時就加以使用;針對高風險清理加入安全性和 CI 技能;若已有經過驗證的清單,涵蓋移除未使用程式碼、抽取模組或將舊式模式現代化,則建立團隊技能。 如果最後需要在多個程式碼庫執行同一輪現代化作業,Codex 可協助將第一次成功的作業轉化為可重複使用的技能。

    相關使用案例