智能技术文档自动生成器

## 技能简介

智能技术文档自动生成器是一款基于人工智能技术的文档编写辅助工具，能够自动分析和理解源代码中的注释、函数签名、类结构等关键元素，并将其转换为规范、易读的技术文档。该工具可显著提升开发团队的文档编写效率，确保文档与代码的同步更新。

## 核心功能

### 1. 多语言支持
支持 Python、JavaScript、TypeScript、Java、C++、Go、Rust 等主流编程语言的代码解析和文档生成。

### 2. 文档格式多样
可生成 Markdown、HTML、ReStructuredText、JSDoc、Javadoc 等多种格式的技术文档，满足不同项目需求。

### 3. 智能内容提取
自动识别并提取以下信息：
- 函数和方法的名称、参数列表、返回值类型
- 类定义、继承关系、接口实现
- 源代码注释和文档字符串
- 常量、变量、枚举类型定义
- 模块依赖关系和导入导出信息

### 4. 结构化输出
生成的文档包含完整的模块说明、函数接口、使用示例、参数详解和返回值说明，确保文档信息完整准确。

## 适用场景

- 新项目启动时的初始文档框架搭建
- 开源项目 README 和 API 文档编写
- 代码重构后的文档同步更新
- 团队内部技术规范文档生成
- 接口文档和 SDK 使用手册编制

## 调用步骤

**第一步：准备源代码**
将需要生成文档的源代码文件整理好，确保代码中包含必要的注释和文档字符串。

**第二步：明确文档需求**
确定目标文档格式（Markdown/HTML/Javadoc 等）和文档详细程度（简要/标准/详细）。

**第三步：输入代码内容**
将源代码粘贴至输入区域，或提供代码文件路径。

**第四步：执行文档生成**
触发文档生成命令，系统将自动分析代码并生成对应文档。

**第五步：审核与调整**
检查生成的文档内容，补充遗漏信息或修正不准确的部分。

## 使用示例

### 输入代码示例
```python
def calculate_rectangle_area(width: float, height: float) -> float:
    """
    计算矩形面积
    
    Args:
        width: 矩形宽度（单位：米）
        height: 矩形高度（单位：米）
        
    Returns:
        矩形面积（单位：平方米）
    """
    return width * height
```

### 生成的文档输出
```markdown
## calculate_rectangle_area

**函数功能**：计算矩形面积

**参数说明**：
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| width | float | 是 | 矩形宽度（单位：米） |
| height | float | 是 | 矩形高度（单位：米） |

**返回值**：float - 矩形面积（单位：平方米）

**使用示例**：
```python
area = calculate_rectangle_area(5.0, 3.0)
print(f"矩形面积为：{area} 平方米")  # 输出：15.0
```
```

## 注意事项

1. **代码质量依赖**：生成的文档质量高度依赖于源代码中注释的完整性和准确性，请确保在编写代码时添加规范的注释和文档字符串。

2. **复杂逻辑说明**：对于复杂的业务逻辑和算法实现，建议在生成的文档基础上手动补充详细的设计思路和实现原理。

3. **安全敏感信息**：生成文档前请检查代码中是否存在敏感信息（如密钥、密码、内部接口地址等），建议在文档生成前进行脱敏处理。

4. **文档审核流程**：自动生成的文档应经过人工审核，确保技术准确性和表达清晰性后再正式使用。

5. **持续维护建议**：代码变更后应及时重新生成文档，建议将文档生成集成到 CI/CD 流程中，实现文档的自动化同步更新。

6. **多语言混用项目**：对于包含多种编程语言的大型项目，建议分模块进行文档生成，以获得更好的解析效果。