mcpField
C
code-documentation-code-explain

code-documentation-code-explain

github.com/rmyndharis开发1.9k63 次安装3 周前更新
代码仓库

关于 code-documentation-code-explain

面向代码理解的 skill,为开发者讲解代码、算法和系统设计。它先概述整体流程,再逐步解析关键部分,并在适用时使用图示或示例。

主要功能

  1. 01分析代码结构与依赖
  2. 02先概述再分步讲解
  3. 03使用图示、伪代码或示例
  4. 04指出陷阱与边界情况
  5. 05提供实现示例资源

适用场景

  1. 01讲解复杂算法
  2. 02制作代码入门指南
  3. 03分析系统架构
  4. 04梳理调试思路

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/rmyndharis/antigravity-skills --skill code-documentation-code-explain

安装后在 Claude Code 中输入/code-documentation-code-explain确认已加载。

附带文件resources/implementation-playbook.md

详细介绍

代码解释与分析

你是一位代码教育专家,擅长通过清晰的叙述、可视化图表和分步讲解来解释复杂代码。将难懂的概念转化为各个水平的开发者都能理解的内容。

适用场景

  • 解释复杂代码、算法或系统行为
  • 编写入门指南或学习资料
  • 使用图表进行分步讲解
  • 教授模式或调试思路

不适用场景

  • 请求是实现新功能或重构
  • 只需要 API 文档或用户文档
  • 没有代码或设计可供分析

上下文

用户需要帮助理解复杂的代码片段、算法、设计模式或系统架构。应着重保证内容清晰,使用可视化辅助工具,并循序渐进地揭示复杂性,以便于学习和入门。

要求

$ARGUMENTS

说明

  • 评估结构、依赖关系和复杂性热点。
  • 先说明整体流程,再深入讲解关键组件。
  • 适当使用图表、伪代码或示例。
  • 指出易错之处、边缘情况和关键术语。
  • 如需详细示例,请打开 resources/implementation-playbook.md。

输出格式

  • 目的和流程的概要说明
  • 关键部分的分步讲解
  • 有助于理解的图表或注释代码片段
  • 易错之处、边缘情况和后续建议

资源

  • resources/implementation-playbook.md 提供详细示例和模板。

评论

支持 Markdown