功能说明: 本技能涵盖 自动化配置和灵活的参数设置、化配置和灵活的参数设置 等核心能力。

explain-code

新手引导

1. 确认运行环境满足依赖说明中的要求
2. 在AI Agent对话中调用本技能,提供必要的输入参数
3. 检查输出结果,根据需要进行后续处理

详细的输入输出格式请参考下方章节说明。

付费版扩展能力

能力	免费版	付费版
基础功能	支持	支持
代码静态分析与质量评分	不支持	支持
依赖缺陷检测与升级建议	不支持	支持
批量代码审查与报告生成	不支持	支持
CI/CD流水线集成	不支持	支持
代码复杂度可视化与重构建议	不支持	支持

场景示例

场景	输入	输出
代码解释	代码片段和语言类型	可视化图表和类比说明
代码库教学	源文件和模块结构	架构概览和关键逻辑解析
工作原理说明	函数或类定义	执行流程图和依赖关系

不适用于：非代码相关的概念解释和知识问答

请求格式

参数名	类型	必填	说明
code	string	是	待解释的代码片段
detail_level	string	否	详细程度, 可选: overview/detailed/line-by-line, 默认: detailed

输出规范

{
  "success": true,
  "data": {
    "overall_grade": "A",
    "total_score": 92,
    "max_score": 100,
    "summary": "处理完成",
    "details": [
      {
        "item": "代码风格",
        "status": "pass",
        "score": 95,
        "comment": "符合规范"
      },
      {
        "item": "安全合规",
        "status": "warn",
        "score": 80,
        "comment": "符合规范"
      }
    ],
    "improvements": [
      {
        "priority": "high",
        "suggestion": "建议优化",
        "expected_gain": "+5分"
      },
      {
        "priority": "medium",
        "suggestion": "建议优化",
        "expected_gain": "+3分"
      }
    ]
  },
  "error": null
}

环境要求

运行环境

• Agent平台: 支持SKILL.md的任意AI Agent(Claude Code / Cursor / Codex / Gemini CLI等)
• 操作系统: Windows / macOS / Linux

工具依赖

依赖项	类型	是否必需	获取方式
LLM API	API	必需	由Agent内置LLM提供

API Key 配置

可用性分类

• 分类: MD+execute()
• 说明: 基于Markdown的AI Skill,

API Key配置方式:

export API_KEY="${API_KEY:?请设置环境变量}"

配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.

技术创新

效率提升量化分析

操作步骤	手动耗时	自动化耗时	时间节约	准确率提升
代码审查	1小时/代码片段	5分钟/代码片段	55分钟	10%
代码生成	2小时/代码功能	10分钟/代码功能	1小时50分钟	15%
代码重构	4小时/代码模块	30分钟/代码模块	3小时30分钟	20%
代码测试	3小时/代码单元	15分钟/代码单元	2小时45分钟	25%
代码优化	6小时/代码性能	1小时/代码性能	5小时	30%

差异化对比

对比维度	本技能	手动操作	Python脚本	专业软件
交互方式	AI交互，可视化展示	文本描述，人工分析	命令行交互，文本输出	图形界面，复杂操作
适应语言	多种编程语言	单一语言	单一语言	多种编程语言
学习成本	低	高	中等	高
成本效益	高	低	中等	高
扩展性	高	低	中等	高

核心痛点解决

痛点	描述	影响范围	解决方案	量化效果
代码理解困难	非专业人员难以理解代码逻辑	影响代码维护和开发效率	提供可视化图表和类比解释	提高理解效率20%
代码审查效率低	人工审查代码耗时且容易出错	影响代码质量和开发进度	自动化审查并提供报告	提高审查效率30%
代码重构复杂	代码重构需要大量时间和经验	影响代码质量和可维护性	提供重构建议和可视化展示	提高重构效率40%

常见问题FAQ

Q1: explain-code支持哪些编程语言？

A: explain-code支持多种编程语言，包括但不限于Python、Java、C++、JavaScript等，具体支持的语言列表请参考官方文档。

Q2: explain-code如何帮助提高代码审查效率？

A: explain-code通过自动化分析代码并提供可视化图表和类比解释，帮助审查者快速理解代码逻辑，提高审查效率。

Q3: explain-code是否支持代码生成功能？

A: 是的，explain-code支持代码生成功能，可以根据提供的输入参数自动生成代码片段。

Q4: explain-code如何处理大型代码库？

A: explain-code支持批量处理功能，可以一次性处理整个代码库，并提供详细的报告。

Q5: explain-code的输出结果是否可以导出？

A: 是的，explain-code的输出结果可以导出为多种格式，如Markdown、PDF等，方便用户进行进一步处理。

诊断与修复

错误现象	可能原因	诊断步骤	解决方案
无法启动	环境变量未配置	检查环境变量配置是否正确	重新配置环境变量
输出结果错误	输入参数错误	检查输入参数是否符合要求	修正输入参数
执行速度慢	网络延迟	检查网络连接	检查网络连接或更换服务器
无法连接到LLM服务	API Key错误	检查API Key是否正确	重新配置API Key
权限不足	运行环境权限不足	检查运行环境权限	调整运行环境权限

安全保证

1. 确保API Key安全，避免泄露到公共代码库。
2. 对输入的代码进行安全检查，防止注入攻击。
3. 定期更新LLM模型，以防止已知漏洞。
4. 对输出结果进行审查，确保不包含敏感信息。
5. 限制技能的使用范围，防止滥用。

安全风险防范

风险项	等级	防护措施	验证方法
API密钥泄露	高	通过环境变量配置，禁止硬编码	定期检查代码和配置文件
命令执行风险	高	仅执行白名单命令，避免拼接用户输入	使用沙箱环境测试
网络通信安全	中	使用HTTPS协议，验证SSL证书	定期检查证书有效期
敏感数据暴露	高	输出结果中不包含密钥、令牌等敏感信息	日志脱敏审查
未授权访问	中	限制访问权限，实施认证机制	定期审计访问日志

异常管理

针对"代码"使用中可能遇到的常见问题,提供以下排查方案:

错误类型	原因分析	解决方案
API认证失败(401)	API密钥错误或过期	检查密钥配置,重新生成token
接口限流(429)	请求频率超出限制	降低调用频率,启用重试退避策略
响应超时(504)	网络延迟或服务端负载过高	增加超时阈值,检查网络连接
文件不存在	路径错误或文件未创建	检查路径拼写,确认文件已生成
文件格式不支持	扩展名不在支持列表中	转换为支持的格式后重试
权限不足	当前用户无读写权限	检查文件权限,以管理员身份运行
命令执行失败	参数错误或环境依赖缺失	检查命令语法,确认依赖已安装
进程超时	命令执行时间过长	增加超时设置,优化命令参数
网络连接失败	DNS解析失败或防火墙拦截	检查网络配置,确认代理设置

"代码"通用排查步骤

1. 检查输入参数: 确认所有必填参数已提供且格式正确
2. 查看日志输出: 定位具体错误行和异常类型
3. 验证环境配置: 确认依赖库版本和运行环境满足要求
4. 逐步调试: 缩小问题范围,隔离故障模块