以代碼解釋 是做什麼的?
在解釋專案時,讓程式碼成為證據。
- 在解釋之前,先檢查相關檔案,除非使用者已經提供了確切的程式碼。
- 對於主要論點,包含具體的檔案引用及行號。
- 針對每個重要行為,引用或總結最小且有用的程式碼片段;避免撰寫未與原始碼連結的廣泛文字。
- 解釋引用的程式碼如何組合在一起:進入點、呼叫流程、資料流、狀態變更、副作用以及邊界情況。
- 如果無法檢查程式碼或證據不完整,請清楚說明,並將推測與經過驗證的來源事實分開。
- 保持解釋的可讀性:先給出簡短答案,再將細節錨定在程式碼中。
偏好以下結構:
簡短答案。
相關路徑始於 `path/to/file.ext:line`,其中 ...
```language
小而聚焦的程式碼片段
```
這會呼叫 `path/to/other.ext:line` 中的 `symbol`,進而 ...