源代码技术文档自动生成器

## 技能概述

源代码技术文档自动生成器是一款专为开发者打造的智能写作技能，能够自动解析各类编程语言源代码中的注释信息与函数签名，快速生成符合行业规范的技术文档。支持 API 文档、类库说明、模块功能描述等多种文档类型。

## 核心功能

- **注释智能解析**：自动识别 JSDoc、docstring、JavaDoc、reST 等多种注释格式
- **签名深度分析**：提取函数名、参数列表、返回值类型及异常说明等关键信息
- **结构化输出**：按标准模板组织文档，包含概述、参数说明、返回值、调用示例等模块
- **多语言兼容**：支持 Python、Java、JavaScript、TypeScript、C++、Go 等主流编程语言
- **格式灵活切换**：可输出 Markdown、HTML、reStructuredText 等多种文档格式

## 调用步骤

1. **整理代码片段**：将需要生成文档的源代码内容准备好
2. **指定输出格式**：告知期望的文档格式（如 Markdown、HTML 等）
3. **提交生成请求**：发送代码内容并说明文档生成的具体需求
4. **获取生成结果**：接收自动生成的文档内容
5. **迭代优化**：对不满意的章节提出修改意见，进行二次精修

## 使用示例

输入如下 Python 函数：

```python
def calculate_tax(income: float, rate: float = 0.1) -> float:
    """计算个人所得税
    
    Args:
        income: 应税收入金额
        rate: 适用税率，默认为 0.1
    
    Returns:
        float: 应缴税额
    """
    return income * rate
```

调用技能后将自动生成包含函数说明、参数详解、返回值说明及调用示例的完整 Markdown 文档。

## 注意事项

- **注释质量决定输出**：源代码中的注释越详细规范，生成的文档质量越高
- **复杂逻辑补充**：涉及复杂业务逻辑的代码，建议人工补充上下文说明
- **依赖关系标注**：包含外部依赖或全局状态的代码，需额外提供上下文信息
- **版本同步维护**：代码修改后应重新生成文档，避免文档与代码不一致
- **敏感信息过滤**：提交前请检查并移除代码中的密钥、密码等敏感数据
- **大文件分批处理**：大型项目建议按模块分批提交，以获得更精准的文档输出
- **人工复核**：自动生成的文档建议由开发者进行最终审核，确保准确性与完整性