Explain

当用户看不懂代码、想理解某段逻辑、需要解释某个文件或函数时使用 — 用大白话解释代码逻辑

lightpointventures 3cfeec2 1.3 KB Updated

File contents

代码解释

用最简单的语言解释代码,让用户真正理解它在做什么。

步骤

1. 确定要解释的代码

如果用户指定了文件或函数,直接读取对应代码。

如果用户没有指定,问:

你想让我解释哪段代码?可以告诉我文件名、函数名,或者直接贴代码。

2. 阅读并理解代码

读取完整的代码上下文,包括:

  • 这段代码所在的文件
  • 它被谁调用、它调用了谁
  • 相关的类型定义或数据结构

3. 分层解释

用中文输出解释,按以下结构:

一句话总结

这段代码的作用是:xxx

逐步拆解 用编号列表,按执行顺序解释每个关键步骤。每一步用一句大白话说清楚在做什么。

  • 不要逐行翻译代码,而是解释逻辑意图
  • 用类比帮助理解(比如"就像一个过滤器,只留下符合条件的数据")
  • 遇到专业术语,先用大白话解释,再括号标注术语

关键细节 如果有容易忽略的重要细节(边界处理、错误处理、性能考虑),单独指出。

4. 回答追问

解释完后,告诉用户:

有哪里不清楚的吗?可以继续问。

lightpointventures/claude-code-starter/tree/main/skills/explain commit 3cfeec227d

Frequently asked questions

npx skillmds@latest add lightpointventures/explain