代码技术文档生成工具

## 技能简介

代码技术文档生成工具是一款基于人工智能的智能文档创作助手，专门用于从源代码中提取关键信息并生成高质量的技术文档。该工具能够自动解析代码注释、函数签名、参数说明、返回值类型以及代码逻辑结构，生成符合规范的技术文档格式，大大提升开发者的文档编写效率。

## 适用场景

该工具适用于多种代码文档生成需求，包括：

- API接口文档编写
- 函数库说明文档生成
- 类和方法说明文档
- 模块功能描述文档
- 代码使用教程撰写

当开发者需要快速为项目生成文档、团队需要统一代码文档格式、或者需要为开源项目编写说明文档时，都可以使用此工具。

## 支持语言

工具支持多种主流编程语言，包括但不限于：

- Python（支持Docstring）
- JavaScript / TypeScript
- Java
- C / C++
- Go
- Rust
- PHP
- Ruby

## 调用步骤

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

提供需要生成文档的源代码文件或代码片段，确保代码包含必要的注释和函数签名。建议使用规范的代码注释风格，如JSDoc、Docstring等。

### 第二步：明确文档要求

明确文档的输出格式要求，可以指定：
- Markdown格式
- HTML格式
- Javadoc格式
- ReDoc格式

### 第三步：生成与审核

根据工具生成的文档内容进行审核，必要时进行补充和调整，确保文档准确反映代码功能。

## 注意事项

1. **代码质量依赖**：生成的文档质量很大程度上取决于源代码中注释的完整性和清晰度，请确保代码包含有意义的注释和文档字符串。

2. **人工审核必要性**：生成的文档应当经过人工审核，特别是涉及参数说明、返回值类型和异常处理等重要信息。

3. **保持同步更新**：生成的文档应与实际代码保持同步更新，避免文档与代码不一致的情况发生。

4. **敏感信息处理**：在生成文档前，请确保代码中不包含敏感信息（如密钥、密码等），如有必要请先进行脱敏处理。

5. **格式规范遵循**：建议团队制定统一的文档规范，以便生成更加一致的文档风格。

## 输出示例

### 函数文档示例

**输入（Python代码）：**
```python
def calculate_sum(a: int, b: int) -> int:
    """
    计算两个整数的和
    
    Args:
        a: 第一个整数
        b: 第二个整数
    
    Returns:
        两个整数的和
    """
    return a + b
```

**输出（Markdown文档）：**
```markdown
### calculate_sum

计算两个整数的和。

**参数：**
- `a` (int): 第一个整数
- `b` (int): 第二个整数

**返回值：**
- (int): 两个整数的和

**示例：**
```python
result = calculate_sum(1, 2)  # 返回 3
```
```