自动化技术文档生成器

## 技能概述

本技能能够自动分析源代码中的注释、函数签名、类定义以及模块结构等信息，快速生成结构化的技术文档。支持 Python、JavaScript、TypeScript、Java、Go、C++ 等主流编程语言，兼容 JSDoc、docstring、Javadoc 等常见文档注释规范。

## 核心功能

- **函数与类解析**：自动提取函数名、参数列表、返回值类型及异常说明
- **注释提取**：解析代码中的文档注释，生成自然语言描述
- **结构化输出**：生成包含目录、模块概览、API 参考等完整章节的文档
- **多格式支持**：输出 Markdown、HTML 等常见文档格式
- **交叉引用**：自动建立函数、类之间的调用关系索引

## 调用步骤

1. **提交代码**：用户提供源代码文本或指定文件路径
2. **语言识别**：自动识别编程语言，或由用户手动指定
3. **配置选项**：选择输出格式（Markdown/HTML）、文档详细程度等参数
4. **代码分析**：技能扫描代码结构，提取函数、类、模块等关键信息
5. **生成文档**：输出结构完整、内容详实的技术文档

## 适用场景

- 开源项目的 README 与 API 文档编写
- 企业内部代码知识库的自动构建
- 第三方库接入文档的快速生成
- 代码评审与重构前的文档梳理
- 新员工入职时的代码导读材料制作

## 注意事项

- 源代码应尽量包含规范的文档注释，注释质量直接影响生成效果
- 复杂的业务逻辑或设计意图建议人工补充说明
- 生成结果建议经人工审核后再正式发布
- 对于使用动态类型或元编程的代码，可能无法完全准确推断类型信息
- 超大型项目建议按模块分批生成，以提高处理效率与文档可读性