关于 explain-code
explain-code 是一项技能,可将指定代码整理成简短、易浏览的说明,适合希望快速理解代码的读者。它采用简明文字和小型代码示例,并遵循固定的标题、TLDR 与分节结构。
主要功能
- 01按指定范围解释
- 02标题与 TLDR 结构
- 03每节说明一个要点
- 04带意图注释的代码片段
- 05忠实行为的简化表达
适用场景
- 01概述函数或代码变更
- 02向新成员解释代码
- 03梳理单条代码路径
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ sidkh/ skills --skill explain-code安装后在 Claude Code 中输入/explain-code确认已加载。
附带文件agents/openai.yaml
详细介绍
解释代码
将用户指定范围内的代码写成一篇简短、易浏览的文章。优先使用通俗易懂的文字和简短的代码示例,而不是详尽的逐步讲解。
默认设置
- 严格遵循用户指定的范围。
- 使用以下结构:
#标题、📋 TLDR,然后是一个或多个##章节。 - 每个
##章节介绍一个要点,并包含至少一个围栏代码块。 - 文字简单,代码片段简短。
- 可以在适当时简化代码,但要忠实于其行为。
- 不要臆测代码或提示词未能支持的意图。
格式
# 标题
用一行通俗易懂的文字点明主题。
📋 TLDR
用 2-3 个简短句子概述要点,让没有编写这段代码的人也能看懂。
只有当流程或交接更容易说明主要内容时,才可选择添加一个小型 mermaid 代码块。
在 📋 TLDR 后添加一条水平分隔线:---。
## 章节
每个章节:
- 使用通俗易懂的
##标题,标题中至少包含一个表情符号。 - 添加一到两句引导语。
- 展示一个围栏代码块。
代码块后立即结束该章节。
用水平分隔线 --- 分隔正文各章节。
文本
- 每句话只表达一个主要观点。
- 尽量使用简短、常见的词语。
- 先说明简单的整体情况,再补充细节。
- 避免冗长的句子、未解释的术语和不公开的简写。
代码
- 只展示说明当前章节要点所需的代码。
- 默认不超过约 10 行非空代码。
- 省略所有无助于理解要点的内容。
- 如果能让要点更清晰,可使用
...、// ...、占位符或简化的标识符。 - 每个代码片段都必须在关键行添加简短的意图注释,说明该行的作用及其重要性。
- 优先使用忠实反映行为的示例,而不是逐字摘录。
范围回退规则
- 如果用户没有指定范围,且存在未暂存的更改,则默认解释未暂存的差异。
- 如果用户没有指定范围,且不存在未暂存的更改,不要猜测要解释什么;应明确请用户指出想要解释的文件、差异或部分。
注意事项
- 不要创建只有文字、没有代码的
##章节。 - 代码块后不要添加解释性文字。
- 如果占位符也能说明要点,就不要包含长字面量、机密信息或不透明的数据块。
- 除非用户明确要求,否则不要把回答写成逐行说明。
评论
支持 Markdown