Codex 應用案例
重構程式碼庫
移除無作用的程式碼,更新老舊寫法,同時維持既有行為。
使用 Codex 將重構拆成易於審查的小步驟,逐步移除無作用的程式碼、理清大型檔案的結構、整合重複邏輯,並更新過時的寫法。
最適合的對象
- 因無作用的程式碼、過大的模組、重複邏輯或過時的抽象設計而難以進行日常修改的程式碼庫。
- 需要在現有框架與技術堆疊內逐步更新程式碼的團隊。
目錄
重構程式碼庫
移除無作用的程式碼,更新老舊寫法,同時維持既有行為。
使用 Codex 將重構拆成易於審查的小步驟,逐步移除無作用的程式碼、理清大型檔案的結構、整合重複邏輯,並更新過時的寫法。
最適合的對象
- 因無作用的程式碼、過大的模組、重複邏輯或過時的抽象設計而難以進行日常修改的程式碼庫。
- 需要在現有框架與技術堆疊內逐步更新程式碼的團隊。
技能與外掛程式
- 每次合併程式碼現代化變更前,先審查可能影響安全性的清理作業、相依套件的變更、身分驗證與授權流程,以及對外開放的介面。
- 將經過驗證的現代化做法、審查清單或行為一致性驗證流程,整理成可在程式碼庫或團隊中重複使用的技能。
| 技能 | 使用理由 |
|---|---|
| Security Best Practices | 每次合併程式碼現代化變更前,先審查可能影響安全性的清理作業、相依套件的變更、身分驗證與授權流程,以及對外開放的介面。 |
| Skill Creator | 將經過驗證的現代化做法、審查清單或行為一致性驗證流程,整理成可在程式碼庫或團隊中重複使用的技能。 |
入門提示詞
簡介
如果程式碼庫累積了未使用的程式碼、重複的邏輯、過時的抽象設計、過大的檔案或老舊的寫法,讓每次修改都得花費過多心力,就該考慮透過重構減少技術債。重構的重點在於改善現有系統的結構,無須更換整套技術堆疊。
Codex 可以先釐清結構混亂的部分,再把清理工作拆成幾個小步驟,方便逐一審查。它可以刪除不再使用的程式碼路徑、理順大型模組的邏輯、合併重複的程式碼路徑、更新過時的框架用法,並加強每個步驟的驗證。
目標是直接改善現有的程式碼庫:
- 移除未使用的程式碼、過時的輔助函式、舊旗標,以及不再需要的相容層。
- 精簡內容繁雜的模組,例如抽出輔助函式、拆分元件,或把會產生副作用的程式碼移到職責更明確的位置。
- 依照程式碼庫現行的慣例改寫老舊的程式碼,例如採用框架較新的基本構件、更清楚的型別、更簡單的狀態傳遞方式,或標準函式庫提供的工具。
- 維持對外行為穩定,同時降低後續修改的成本。
使用方式
- 編輯前,先請 Codex 盤點要重構的範圍,找出內容繁雜的模組、重複的邏輯、未使用的程式碼、相關測試、對外介面契約,以及已不適合這個程式碼庫的舊寫法。
- 每次只選一項清理重點,例如移除未使用的程式碼、簡化控制流程、更新過時的寫法,或將大型檔案拆成較小且維護責任明確的單元。
- 在 Codex 修改檔案前,先請它說明目前的行為、打算如何改善結構,以及哪項最小範圍的檢查足以確認行為維持不變。
- 每完成一輪就審查變更,並執行足以驗證結果的最小範圍檢查,避免把整次清理的變更集中在同一份差異檔中。
- 除非清理工作必須涵蓋技術堆疊變更、相依套件遷移或架構調整,否則請將這些工作分別列為獨立任務。
開始重構前,可以使用規劃模式擬定重構計畫。
運用 ExecPlans
程式碼現代化實作指南 介紹了 ExecPlans。Codex 可以透過這類文件掌握清理工作的全貌、說明預期的最終狀態,並在每輪清理後記錄驗證結果。 如果重構涉及多個模組,或需要分多個工作階段才能完成,ExecPlans 就很實用。可以用這類文件記錄刪除了哪些內容、更新了哪些寫法、哪些介面契約必須維持不變,以及哪些工作仍待日後處理。
使用技能處理重複出現的清理工作
當多個程式碼庫、服務或團隊反覆使用同一套清理規則時,就可以運用技能。如果有適用於特定框架的技能,請使用該技能。清理工作風險較高時,請搭配資安和 CI 技能。如果團隊已有經過驗證的檢查清單,用於移除未使用的程式碼、抽出模組或更新老舊寫法,請據此建立團隊技能。 如果需要在多個程式碼庫進行相同的現代化工作,Codex 可以協助你將第一次成功的做法整理成可重複使用的技能。
相關應用案例
執行程式碼遷移
使用 Codex 釐清舊系統與新技術堆疊的對應關係,分階段完成遷移,並在每次切換前確認新舊系統的行為一致。
建立 Codex 可使用的 CLI
請 Codex 建立一套 CLI,讓它能在任何資料夾中執行 CLI 指令、搭配程式碼庫中的指令碼使用,也能下載檔案。再請它建立配套技能,讓 Codex 日後記得如何使用這套 CLI。
從議題到經過測試的 pull request
將範圍明確的議題交給 Codex,準備好雲端環境,並列出必要的檢查項目。Codex 會交付可供審查的程式碼變更,附上測試、文件,以及每項驗收條件的驗證依據。