关于 explaining-code
一种代码讲解技能,规定了对话式说明的固定结构:从日常类比开始,加入 ASCII 图示,逐步讲解,并指出常见陷阱。
主要功能
- 01以日常类比开篇
- 02用 ASCII 展示流程或结构
- 03逐步说明代码执行过程
- 04指出常见陷阱
适用场景
- 01向新团队成员说明代码路径
- 02用类比讲解复杂概念
- 03阐明代码流程与常见错误
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ generativeagents/ training-claude-code --skill explaining-code安装后在 Claude Code 中输入/explaining-code确认已加载。
详细介绍
解释代码时,始终包括:
- 先打个比方:将代码比作日常生活中的某样东西
- 画出示意图:用 ASCII 艺术图展示流程、结构或关系
- 逐步讲解代码:逐步说明会发生什么
- 指出一个易错点:常见的错误或误解是什么?
讲解时保持轻松对话的语气。对于复杂概念,可以使用多个类比。
评论
支持 Markdown