Beginner
5 minutes
How to 理解大型程式碼庫 with Eigent
追蹤請求流程、梳理陌生模組,並在你第一次修改之前快速找出正確檔案。
What you need
- Eigent 桌面應用程式
- 程式碼庫存取權(本機或已連接的儲存庫)
Best for
- 正在為儲存庫或服務上手的新工程師
- 任何想在修改前先了解功能如何運作的人
- 在合作開始前審視新程式碼庫的技術主管
Starter Prompt
解釋請求在程式碼庫中如何流經 [name of the system area]。 請包含: - 哪些模組負責哪些部分 - 資料在哪裡被驗證 - 在我開始修改前需要留意的主要陷阱 最後請列出我接下來應該閱讀的檔案。
運作方式
- 將相關的檔案、目錄或你想理解的功能區域提供給 Eigent。
- 請它追蹤請求流程,並說明哪些模組負責業務邏輯、傳輸、持久化或 UI。
- 在你編輯任何內容之前,詢問驗證、副作用或狀態轉換發生在哪裡。
- 最後詢問你接下來應該閱讀哪些檔案,以及有哪些高風險位置。
進階提示
- 哪個模組負責實際業務邏輯,而不是傳輸層或 UI 層?
- 驗證在哪裡發生,那裡強制了哪些假設?
- 如果我改動這條流程,還有哪些相關檔案或背景工作很容易漏掉?
- 編輯這個區域後,我應該執行哪些測試或檢查?
- 向我解釋這個儲存庫——在我深入之前先給我一張高層次地圖。
使用方法
在連接了程式碼庫的情況下開啟 Eigent。若你是新手,先從大範圍開始(例如「向我解釋這個儲存庫」),再縮小到你需要修改的具體區域。你設定的請求範圍越明確——功能名稱、目錄、請求路徑——得到的解釋就會越具體。持續提出跟進問題,直到說明具體到足以讓你放心開始第一次修改。
預期輸出
一份具體的模組地圖,顯示哪些程式碼負責哪些部分;一條已追蹤的請求流程;關鍵驗證檢查點;一份高風險或容易忽略區域的清單;以及在修改前應先檢視的下一批檔案閱讀清單。
限制
- 最適合先將請求範圍縮小到特定區域,而不是一次詢問整個儲存庫。
- 非常大型的 monorepo 最好先縮小到單一服務或套件。
- Eigent 只會根據已連接程式碼庫中的內容進行閱讀——它無法推斷尚未觀察到的執行時行為。