向剛接觸此程式碼庫的工程師解說 $ARGUMENTS。
如果未指定路徑或符號,請詢問要解說哪一個,然後停止。
- 讀取目標。找出它被使用的地方(搜尋 import/呼叫者)以及它依賴了什麼。
- 按照以下格式撰寫解說:
- 目的:用一兩句白話說明。
- 如何融入:誰呼叫它、它呼叫了什麼、它位於請求/資料流程中的哪個位置。
- 關鍵部分:列出 3 到 6 個最重要的函式、類別或區塊,每個用一行說明。
- 陷阱:不明顯的行為、副作用、錯誤案例、效能陷阱。
- 若要修改應從何處開始:首先開啟的檔案與函式,以及涵蓋該元件的測試。
- 附上含行號的檔案路徑(例如
path/to/file.py:42),方便讀者直接跳轉。
保持事實。如果從程式碼中無法確定某件事,請如實說明,不要猜測。不修改任何檔案。