看不懂的代碼怎麼辦:逐段解釋陌生代碼與項目結構提示詞

接手別人項目、讀開原始碼或學習新框架時用:先講清整體用途和數據流,再按段解釋關鍵邏輯,並告訴你要實現某個改動應該從哪裏下手。

NNathaniel bigo··原創首發·AI 輔助撰寫
通用大模型 對話模型通用
【角色】你是一名善於講解的資深工程師,能根據聽眾的水平調整解釋深度。

【背景】
- 我的背景:[我的技術背景]
- 閱讀目的:[如接手維護、學習、改某個功能]
- 項目目錄結構(如有):
  [目錄結構]
- 代碼:
  [粘貼代碼]

【任務】
1. 總覽:這段代碼或這個項目做什麼,入口在哪裏,主要數據怎樣流動。
2. 用 Mermaid 流程圖或時序圖畫出核心調用關係。
3. 逐段解釋關鍵邏輯:每段做什麼、為什麼這樣寫;遇到我可能不熟悉的語法、設計模式或庫,單獨用一兩句話解釋。
4. 指出需要特別注意的地方:隱含假設、副作用、全局狀態、潛在的坑。
5. 結合我的閱讀目的,告訴我應該修改哪些文件或函數,以及改動的影響範圍。
6. 出 3 個小問題,幫我檢驗是否真正理解。

【約束】
- 區分「從代碼中能確定的」和「推測的」,推測要標明。
- 不要逐行翻譯顯而易見的代碼,把篇幅留給關鍵邏輯。
- 按我的技術背景調整術語深度。

【輸出格式】
總覽 → 調用關係圖(Mermaid 代碼塊)→ 分段解釋 → 注意事項 → 修改指引 → 自測問題。

高亮處換成你自己的內容:[我的技術背景]、[如接手維護、學習、改某個功能]、[目錄結構]、[粘貼代碼]

ChatGPT Plus 充值

已被複製 0 次

使用說明

怎麼填變量:[我的技術背景] 寫實際情況,如「會 Python,第一次看 React」,解釋深度會差很多;[目錄結構] 可以用 tree -L 2 命令導出。代碼太多時先貼入口文件,再按需追加。

追問技巧:對某段沒懂,直接說「第 3 部分再講細一點,舉個具體輸入的例子」;理解後可以追問「如果要加 [新功能],給出改動方案」。

適合模型:通用大模型均可;整個代碼庫的理解建議用能讀取項目文件的編程助手。

注意保密:公司代碼請按團隊規定使用經授權的 AI 工具。

示例輸出

示例,僅供參考

總覽:這是一個 Flask 接口,接收訂單請求,校驗庫存後寫入數據庫,再異步發送通知。

mermaid
sequenceDiagram
  Client->>API: POST /orders
  API->>Stock: check_stock()
  API->>DB: insert order
  API-->>Queue: send_notification

注意:check_stock() 與扣減庫存不在同一事務裏,高並發時可能超賣(推測,需確認數據庫配置)。

同款作品

用這條提示詞做出來的作品;原作者會因此獲得積分

做同款

還沒有同款,來做第一個。

Nathaniel 的更多內容

同主題

同模型

0 條評論

登入 後參與評論

還沒有評論,來搶沙發~