Codex use case
瞭解大型程式碼庫
追蹤請求流程、梳理陌生模組,並快速找出正確的檔案。
Difficulty 簡單
Time horizon 5 分鐘
使用 Codex 梳理陌生的程式碼庫、說明不同模組與資料流程,並在編輯前指出接下來值得閱讀的檔案。
最適合
- 需要熟悉新程式碼庫或服務的新進工程師
- 任何想在變更功能前瞭解其運作方式的人
Contents
瞭解大型程式碼庫
追蹤請求流程、梳理陌生模組,並快速找出正確的檔案。
使用 Codex 梳理陌生的程式碼庫、說明不同模組與資料流程,並在編輯前指出接下來值得閱讀的檔案。
簡單
5 分鐘
最適合
- 需要熟悉新程式碼庫或服務的新進工程師
- 任何想在變更功能前瞭解其運作方式的人
起始提示詞
說明在程式碼庫的 <name of the system area> 中,請求如何流轉。
請包含:
- 各模組負責哪些部分
- 在何處驗證資料
- 變更前最需要留意的常見陷阱
最後列出我接下來應閱讀的檔案。
說明在程式碼庫的 <name of the system area> 中,請求如何流轉。
請包含:
- 各模組負責哪些部分
- 在何處驗證資料
- 變更前最需要留意的常見陷阱
最後列出我接下來應閱讀的檔案。
簡介
當你剛接觸某個程式碼庫,或突然需要處理不熟悉的功能時,Codex 可以協助你在開始修改程式碼前快速掌握狀況。目標不只是取得概略摘要,還要梳理請求流程、瞭解各模組的職責,並找出接下來值得閱讀的檔案。
使用方式
如果你剛接觸某個專案,最簡單的起點就是請 Codex 說明整個程式碼庫:
向我說明這個程式碼庫
如果你要為現有程式碼庫新增功能,可以請 Codex 說明特定的系統區域。要求範圍界定得越明確,說明就越具體:
- 將與你想瞭解的內容相關的檔案、目錄或功能區域提供給 Codex。
- 請它追蹤請求流程,並說明哪些模組分別負責商業邏輯、傳輸、持久化或 UI。
- 在編輯任何內容之前,先詢問驗證、副作用或狀態轉換發生的位置。
- 最後,詢問接下來應閱讀哪些檔案,以及有哪些高風險環節。
有效的上手說明應讓你掌握清楚具體的脈絡,而不只是一份檔案名稱清單。最後,Codex 應說明主要流程、標出高風險部分,並指出你在開始編輯前,接下來應查看哪些檔案或執行哪些重要檢查。
接下來可問的問題
Codex 初步說明後,請繼續追問,直到內容具體到足以讓你有把握進行第一次編輯。好的後續問題通常能促使 Codex 點出各項假設、隱藏的相依性,以及變更後的重要檢查項目。
- 實際的商業邏輯與傳輸層或 UI 層,分別由哪些模組負責?
- 驗證在何處進行,又會在該處強制確保哪些假設成立?
- 如果我變更這個流程,有哪些相關檔案或背景工作容易遺漏?
- 編輯這個區域後,我應執行哪些測試或檢查?