mcpField
C
code-documentation-code-explain

code-documentation-code-explain

github.com/sickn33开发48.7k1.0k 次安装今天更新
代码仓库

关于 code-documentation-code-explain

code-documentation-code-explain 是用于讲解和分析代码、算法及系统设计的技能,通过分步说明、图示和示例帮助开发者理解,并指出潜在问题。

主要功能

  1. 01说明整体流程与关键组件
  2. 02逐步拆解代码
  3. 03适时使用图示或伪代码
  4. 04指出陷阱与边界情况
  5. 05支持入门讲解与学习材料

适用场景

  1. 01讲解陌生代码库
  2. 02教学算法或设计模式
  3. 03编写开发者入门指南
  4. 04分析调试中的程序行为

安装

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

$npx skills add https://github.com/sickn33/agentic-awesome-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:详细示例和模板。

限制

  • 仅当任务明确符合上述范围时,才使用此技能。
  • 不要将输出视为替代环境特定的验证、测试或专家审查。
  • 如果缺少必要输入、权限、安全边界或成功标准,请停止并请求澄清。

实现限制

此操作手册仅作为教学框架:其中省略了复杂度、嵌套、模式、依赖关系和难度辅助工具;{specific_use_in_code} 和 {code_analysis} 等模板字段需要根据证据替换。未知指标必须保持未知。AST 和正则表达式匹配只能提示语法或可能存在的模式,不能证明行为、运行时调用目标、安全性或学习者的知识缺口。除非另有授权在隔离环境中执行,否则应静态解释代码。

递归图仅涵盖 factorial(3);异步 fetch 示例模拟 sleep,不会发出 HTTP 请求。调整示例时应限制任务数量和并发数。时长仅为示例,并非测量结果。Mermaid 标识符和标签需要转义,并使用稳定的生成 ID;调用图必须处理本地函数映射中不存在的外部被调用对象。不要将不可信标签渲染为可执行标记,也不要声称基于名称匹配生成的调用图是完整的。

评论

支持 Markdown