代码技术文档自动生成助手

# 代码技术文档自动生成助手

## 技能简介

代码技术文档自动生成助手是一款专注于将源代码注释和函数签名转化为专业、易读技术文档的智能工具。通过深度分析代码结构、命名规范和注释内容，自动生成符合行业标准的技术文档，帮助开发者快速构建完整的项目文档体系。

## 核心功能

### 文档类型支持

- **API 接口文档**：自动解析接口参数、返回值、请求示例
- **函数/方法文档**：生成函数说明、参数描述、使用示例
- **类文档**：提取类属性、方法、继承关系
- **项目 README**：自动生成项目概述、安装指南、使用说明

### 智能解析能力

- 支持多种编程语言：Python、JavaScript、TypeScript、Java、Go、C# 等
- 自动识别代码结构：类、函数、接口、模块
- 提取注释中的关键信息：参数说明、返回值、异常处理
- 分析命名规范生成描述性文档

## 调用步骤

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

将需要生成文档的代码片段粘贴到对话中，支持以下格式：
- 单个函数或方法
- 完整的类定义
- 整个文件或模块
- GitHub/GitLab 代码链接

### 第二步：指定文档类型

明确说明需要生成的文档类型，可选格式：
- `请生成 API 文档`
- `请生成函数说明文档`
- `请生成完整项目 README`
- `请生成使用示例`

### 第三步：设置输出偏好

可根据需要指定：
- 文档详细程度（简洁版/详细版）
- 文档语言（中文/英文）
- 是否包含代码示例
- 文档格式偏好

### 第四步：获取并审核文档

系统将自动生成文档，建议：
- 检查技术细节准确性
- 根据实际需求补充特殊说明
- 调整格式以匹配项目规范

## 使用示例

**输入代码：**
```python
def calculate_statistics(data: List[float], method: str = "mean") -> Dict[str, float]:
    """
    计算数据集合的统计指标
    
    Args:
        data: 数值型数据列表
        method: 统计方法，支持 mean/median/std
    
    Returns:
        包含统计结果的字典
    """
    pass
```

**生成文档：**
将自动输出符合规范的技术文档，包含函数说明、参数详解、返回值描述、使用示例等完整内容。

## 注意事项

### 代码质量依赖

生成文档的质量高度依赖源代码的注释质量和结构清晰度。建议在编写代码时遵循以下规范以获得更好的文档生成效果：

- 使用规范的注释格式（如 JSDoc、Docstring）
- 为函数和参数提供清晰的命名
- 在注释中详细说明参数范围、默认值、异常情况

### 多语言混合项目

对于包含多种编程语言的项目，建议分批处理，每次针对单一语言代码生成文档，以确保文档风格的一致性和准确性。

### 敏感信息处理

在提交代码前，请注意：
- 移除或替换硬编码的密钥、密码、API Token 等敏感信息
- 使用占位符代替真实的生产环境配置
- 检查生成的文档中是否包含不应公开的信息

### 文档审核

自动生成的文档作为初稿使用，开发者应当：
- 验证技术描述的准确性
- 补充业务逻辑相关的背景说明
- 完善错误处理和边界情况的说明
- 确保文档符合团队或项目的编码规范

## 适用场景

- 新项目启动时的快速文档构建
- 开源项目的 README 和 API 文档编写
- 代码重构后的文档更新
- 团队内部技术文档的规范化整理
- 遗留代码的文档补全