代码文档生成助手

## 技能简介

代码文档生成助手是一款基于人工智能的技术文档自动生成工具。它能够分析源代码中的注释、函数签名、类定义和参数说明，自动生成符合行业规范的技术文档。无论是API接口文档、SDK使用手册还是代码库说明文档，都能快速生成，大幅提升开发者的文档编写效率。

## 适用场景

- **新项目初始化**：为新启动的项目快速生成基础文档结构
- **开源项目维护**：为开源代码库生成专业的英文或中文文档
- **团队协作开发**：统一团队代码文档格式和风格
- **遗留代码重构**：为缺乏文档的历史代码补充说明
- **SDK/工具库发布**：生成符合标准的开发者文档
- **技术分享准备**：将代码示例转换为教学文档

## 调用步骤

### 第一步：准备源代码

将需要生成文档的源代码复制到剪贴板。支持的代码格式包括：

- Python、JavaScript/TypeScript、Java
- Go、Rust、C/C++
- Ruby、PHP、Swift、Kotlin

建议包含完整的注释信息，包括 JSDoc、Docstring、JavaDoc 等标准注释格式。

### 第二步：指定文档需求

在调用时明确以下信息：

1. **目标语言**：指定生成文档的语言（中文/英文）
2. **文档类型**：API文档、使用教程、架构说明等
3. **详细程度**：简略版/标准版/详细版
4. **特殊要求**：是否需要包含示例代码、注意事项等

### 第三步：获取生成结果

系统将自动分析代码结构，生成包含以下部分的完整文档：

- 模块/类概述
- 函数/方法说明
- 参数及返回值描述
- 使用示例代码
- 注意事项和最佳实践

## 支持的文档格式

| 格式类型 | 输出样式 |
|---------|---------|
| Markdown | 标准的 `.md` 文件格式，适合GitHub文档 |
| HTML | 可直接预览的网页格式 |
| PDF说明 | 结构化的打印友好格式 |
| OpenAPI | 符合Swagger规范的API描述 |

## 注意事项

### 代码质量要求

- 确保源代码中的注释语法正确，格式规范
- 函数和类的命名应具有自描述性
- 复杂的业务逻辑建议添加行内注释说明

### 文档准确性

- 生成后请仔细检查文档内容的准确性
- 对于自动推断的类型和返回值，建议人工核实
- 关键的业务规则和限制条件需要手动补充

### 格式兼容

- 如果代码包含非标准注释格式，可能会影响生成质量
- 多语言混合的代码文件建议拆分后分别处理
- 对于使用特殊框架语法的代码，请注明框架类型

### 知识产权考量

- 确保有权将代码用于文档生成
- 生成的技术文档应遵守相关开源协议
- 敏感的业务逻辑和内部实现细节请谨慎处理

## 使用建议

1. **分批处理**：大量代码建议分模块逐步生成，便于审核
2. **迭代优化**：首次生成后可根据需要调整注释再次生成
3. **人工审核**：重要项目的文档必须经过人工审核确认
4. **版本同步**：代码更新后及时重新生成对应文档

通过合理使用代码文档生成助手，可以将文档编写效率提升3-5倍，让开发者有更多时间专注于核心代码开发工作。