SkillSub Pro - Python 题解与代码注释双功能技能

技能简介

SkillSub Pro 是一个 Python 题解生成与代码注释的双功能合体技能，专为学生、算法学习者和开发者设计。

✅ 一个技能，两种用途：

• 📝 题解模式：输入题目/题号，自动生成完整 Python 题解（含详细注释、解题思路、复杂度分析）
• 💬 注释模式：输入 Python 代码，自动添加详细中文注释（函数 docstring、参数说明、返回值、关键逻辑）

✅ 智能识别：自动检测输入类型（题目描述 vs Python 代码），无需手动切换功能

功能详解

模式 1：题解生成

输入：题目编号、题目描述、或问题描述
输出：完整 Python 题解 + 详细注释 + 解题思路 + 复杂度分析

示例：

用户：LeetCode 1 两数之和

助手：
## 解题思路
使用哈希表存储已遍历的元素...

## 完整代码
```python
def two_sum(nums, target):
    """
    找出数组中和为 target 的两个数的索引
    ...
    """
    # 哈希表：存储数值 -> 索引的映射
    ...

复杂度分析

• 时间：O(n)
• 空间：O(n)

---

### 模式 2：代码注释

**输入**：现有 Python 代码  
**输出**：添加详细中文注释后的完整代码

**示例**：

用户：

def bubble_sort(arr):
    n = len(arr)
    for i in range(n):
        for j in range(0, n-i-1):
            if arr[j] > arr[j+1]:
                arr[j], arr[j+1] = arr[j+1], arr[j]
    return arr

助手：[自动识别为注释模式，添加详细注释]

---

## 核心特性

✅ **自动识别输入类型**，智能切换模式  
✅ **题解模式**：生成完整可运行代码 + 详细注释 + 思路分析  
✅ **注释模式**：为现有代码添加规范的中文注释（PEP 257）  
✅ **一键使用**，无需手动切换功能  
✅ **多解法支持**（暴力法、优化法对比）  
✅ **算法模板库**（`references/common_algorithms.md`）  
✅ **代码验证脚本**（`scripts/validate_code.py`）  

---

## 适用场景

| 场景 | 使用模式 | 示例 |
|------|---------|------|
| 学生作业 | 题解模式 | "Python 实现二分查找" |
| LeetCode 刷题 | 题解模式 | "LeetCode 146 LRU Cache" |
| 代码审查 | 注释模式 | [粘贴需要理解的代码] |
| 算法学习 | 题解模式 | "讲解动态规划解 0-1 背包" |
| 教学演示 | 题解模式 | "用 Python 实现决策树" |
| 面试准备 | 题解模式 | "反转链表的三种方法" |
| 代码重构 | 注释模式 | [粘贴旧代码请求加注释] |

---

## 安装方法

### 方法 1：从 SkillHub 安装（推荐）
```bash
skillhub install skillsub-pro

方法 2：本地安装（开发版）

skillhub install /path/to/skillsub-pro.skill

使用方法

题解模式触发条件（满足任一）

• 输入包含题目编号（如 "LeetCode 1", "#2", "题目 100"）
• 输入包含问题描述（如 "给定一个数组", "实现函数", "求最大值"）
• 输入明确要求 "题解"、"解题"、"写代码"、"代码实现"

注释模式触发条件（满足任一）

• 输入包含 Python 代码块（有 def, class, import, = 等语法）
• 输入包含代码标记（如 ```python, 代码:, code:）
• 输入明确要求 "加注释"、"注释"、"解释代码"

示例对话

示例 1：题解模式（题目编号）

用户：LeetCode 1 两数之和

助手：
## 解题思路
使用哈希表存储已遍历的元素...

## 完整代码
[带详细注释的完整代码]

## 复杂度分析
- 时间：O(n)
- 空间：O(n)

示例 2：注释模式（代码片段）

用户：
```python
def quick_sort(arr):
    if len(arr) <= 1:
        return arr
    pivot = arr[len(arr) // 2]
    left = [x for x in arr if x < pivot]
    middle = [x for x in arr if x == pivot]
    right = [x for x in arr if x > pivot]
    return quick_sort(left) + middle + quick_sort(right)

助手：[为这段代码添加详细中文注释，解释快速排序的分治思想和分区过程]

---

## 技能优势

相比单一功能技能或基础版本：

✅ **双功能合体** - 一个技能解决两类需求（题解 + 注释）  
✅ **自动识别** - 无需手动切换，智能判断输入类型  
✅ **注释详细** - 符合教学要求，适合作业提交和代码审查  
✅ **代码规范** - 遵循 PEP 8 和 PEP 257，专业可靠  
✅ **思路清晰** - 不仅给代码，还解释算法思想  
✅ **多解法支持** - 提供暴力法和优化法，标注推荐  
✅ **测试友好** - 可选生成测试用例，方便验证  
✅ **算法模板** - 内置常见算法模板，参考规范实现  
✅ **代码验证** - 提供验证脚本，确保生成代码质量  

---

## 内置资源

### 1. 脚本工具
- **`scripts/validate_code.py`**：验证生成代码的语法和规范性
  ```bash
  python scripts/validate_code.py solution.py

2. 参考文档

• references/common_algorithms.md：常见算法模板库
  • 排序算法（快速排序、归并排序）
  • 查找算法（二分查找）
  • 动态规划（0-1 背包、LCS）
  • 贪心算法（活动选择）
  • 回溯算法（N 皇后）
  • 图算法（Dijkstra）
  • 数据结构（二叉树、LRU Cache）

进阶技巧

1. 请求特定解法

• "用动态规划解这道题"
• "提供暴力法和优化法两种解法"

2. 请求特定注释风格

• "按照 Google 风格加注释"
• "注释详细一些，我是初学者"

3. 结合两种模式

• 先生成题解 → 再请求为生成的代码加更详细注释
• 先注释现有代码 → 再请求优化并提供更优解法

4. 批量处理

• 提供一个文件多个函数 → 批量添加注释
• 提供多个题目 → 逐个生成题解

5. 使用验证脚本

• 生成代码后 → 运行 python scripts/validate_code.py 验证
• 确保生成的代码语法正确且符合规范

6. 参考算法模板

• 生成算法题解前 → 先阅读 references/common_algorithms.md
• 参考标准实现和复杂度分析

Windows 用户注意事项

如果遇到 UnicodeEncodeError（中文编码错误），请设置环境变量：

$env:PYTHONUTF8=1

或在代码中添加：

import sys
import io
sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8')

版本历史

• v2.1 (Pro - 完整版) - 2026-05-17

  • ✅ 新增验证脚本 scripts/validate_code.py
  • ✅ 新增算法模板 references/common_algorithms.md
  • ✅ 增加"使用资源"章节，引用脚本和参考文档
  • ✅ 增加进阶技巧 5 和 6（验证脚本和算法模板）
  • ✅ 技能优势增加最后两项（算法模板、代码验证）
  • ✅ 增加"Windows 用户注意事项"

• v2.0 (Pro) - 2026-05-17

  • ✅ 优化触发描述（增加更多触发词）
  • ✅ 精简结构（移除冗余内容）
  • ✅ 增强注释规范（增加 docstring 示例）
  • ✅ 增加多解法支持
  • ✅ 增加进阶技巧和批量处理指南
  • ✅ 增加适用场景表格

• v1.0 (基础版) - 2026-05-17

  • 初始版本，双功能合体

作者与反馈

作者：QClaw
最后更新：2026-05-17
问题反馈：请在 SkillHub 页面提交 Issue 或 Pull Request

许可证

MIT License（详见 LICENSE 文件）