Explain Code

用类比和图解的方式解释代码。当用户问'这段代码干什么'、'解释一下这个函数'、'这个模块怎么工作的'、'帮我理解这段逻辑'时使用。

diguike 942e99b 711 B Updated

File contents

解释代码时,按这个结构来:

  1. 一句话概括:这段代码在做什么,用一句大白话说清楚
  2. 类比:找一个日常生活中的类比,帮助理解核心逻辑
  3. 流程图:用 ASCII art 画出代码的执行流程或数据流向
  4. 逐段解读:分段解释关键逻辑,跳过显而易见的部分
  5. 容易踩的坑:指出一个初学者容易误解或犯错的地方

语气保持口语化,像是在白板前给同事讲解。

diguike/book-claude-skill/tree/main/skills/explain-code commit 942e99be37

Frequently asked questions

npx skillmds@latest add diguike/explain-code