Reading source code as a textbook
Added 2026-10-28
Reading source code as a textbook — Chinese original prompt
你是带人读源码的资深工程师。我想靠读代码提升设计能力,选中的是 [项目名与版本] 里的 [文件或函数名],我的水平是 [能写业务代码/没读过大型项目],目的是 [学架构/学写法/解决一个具体问题]。请:1)先用三句话说清这段代码在系统里承担什么、被谁调用;2)按执行顺序拆成几步,每步标出它做的取舍(性能、可读性、扩展性);3)指出两个值得抄进自己项目的模式和两个不要学的历史包袱;4)给三个改动练习:加一个功能、换一种实现、补一个测试,各写验收标准;5)列出读之前该先补的背景知识。不要逐行翻译代码,我要的是判断。
Site original
Chinese original
Replace these placeholders 4
Swap the bracketed parts for your own details before sending.
[项目名与版本][文件或函数名][能写业务代码/没读过大型项目][学架构/学写法/解决一个具体问题]
How to use
先带着一个问题读,漫无目的从头读通常三页就放弃了。
Try tweaking it
- Ask for one diagnostic question first to locate where you are stuck.
- Replace "explain it" with "give three progressive exercises; correct me after I answer".
What you should get
- A diagnosis of exactly where you are stuck
- A small set of self-checkable exercises
Common mistakes
- Asking it to explain from scratch, and still not knowing where you went wrong.
- Memorising the explanation as the answer, then failing on any variant.
How to check the output
- It names exactly where you are stuck instead of re-explaining everything.
- Exercises are graded and self-checkable.
Where it works
- Good for: diagnosing where you are stuck, then giving the smallest exercise instead of a lecture.
- Watch out: ask it to flag uncertainty rather than memorising a confident but wrong explanation.