看不懂的代码怎么办:逐段解释陌生代码与项目结构提示词

接手别人项目、读开源代码或学习新框架时用:先讲清整体用途和数据流,再按段解释关键逻辑,并告诉你要实现某个改动应该从哪里下手。

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 条评论

登录 后参与评论

还没有评论,来抢沙发~