Codex 應用案例
了解大型程式碼庫
追蹤請求的處理流程,釐清陌生模組之間的關係,快速找到需要的檔案。
難度 Easy
任務時間跨度 5m
讓 Codex 幫你梳理陌生程式碼庫的架構,說明各模組的職責與資料流向,並指出動手修改前值得先讀的檔案。
最適合的對象
- 剛開始熟悉新程式碼庫或服務的工程師
- 想在修改功能前先了解其運作方式的人
目錄
了解大型程式碼庫
追蹤請求的處理流程,釐清陌生模組之間的關係,快速找到需要的檔案。
讓 Codex 幫你梳理陌生程式碼庫的架構,說明各模組的職責與資料流向,並指出動手修改前值得先讀的檔案。
Easy
5m
最適合的對象
- 剛開始熟悉新程式碼庫或服務的工程師
- 想在修改功能前先了解其運作方式的人
入門提示詞
請說明在這個程式碼庫中,請求進入 <name of the system area> 後會經過哪些處理步驟。
請涵蓋以下重點:
- 各模組分別負責什麼
- 哪些地方會驗證資料
- 動手修改前有哪些容易忽略的重要問題
最後,請列出我接下來應該閱讀的檔案。
請說明在這個程式碼庫中,請求進入 <name of the system area> 後會經過哪些處理步驟。
請涵蓋以下重點:
- 各模組分別負責什麼
- 哪些地方會驗證資料
- 動手修改前有哪些容易忽略的重要問題
最後,請列出我接下來應該閱讀的檔案。
簡介
剛接觸一個程式碼庫,或接手不熟悉的功能時,Codex 可以在你動手修改程式碼前,幫你弄清楚系統如何運作。除了掌握全貌,你還要釐清請求的處理流程、了解各模組的職責,並找出接下來值得閱讀的檔案。
使用方式
如果你剛加入專案,可以先請 Codex 介紹整個程式碼庫。
請向我介紹這個程式碼庫
如果你要在現有的程式碼庫中開發新功能,可以請 Codex 說明系統中與這項功能相關的部分。提問範圍越明確,得到的說明就越具體。
- 提供相關檔案或目錄,或告訴 Codex 你想了解哪一部分的功能。
- 請 Codex 追蹤請求的處理流程,並說明哪些模組分別負責業務邏輯、資料傳輸、資料持久化或使用者介面。
- 動手修改前,先問清楚程式在哪些地方執行驗證、產生副作用或轉換狀態。
- 最後,請 Codex 指出接下來應該閱讀哪些檔案,以及哪些地方修改起來風險較高。
一份有助於上手的說明,除了列出檔名,也應該讓你看懂各部分如何串連起來。讀完後,你應該能從 Codex 的說明中掌握主要流程、辨識風險較高的部分,並知道動手修改前該先閱讀哪些檔案或執行哪些檢查。
接下來可以問什麼
看完 Codex 的初步說明後,繼續追問細節,直到你有把握動手做第一次修改。好的追問通常能讓 Codex 明確指出程式依賴哪些假設、有哪些不易察覺的相依關係,以及修改後應該做哪些檢查。
- 哪個模組實際負責業務邏輯?哪些模組負責傳輸層或使用者介面層?
- 程式在哪裡執行驗證?這些驗證確保哪些假設成立?
- 修改這個流程時,有哪些相關檔案或背景作業容易被忽略?
- 修改這部分程式碼後,我應該執行哪些測試或檢查?