AI技术文档自动生成器

## 技能简介

AI技术文档自动生成器是一款基于人工智能的高级文档生成工具，能够深度解析源代码中的注释信息、函数签名、类结构、参数定义及返回值类型，自动将其转换为格式规范、内容完整的技术文档。该工具支持Python、JavaScript、TypeScript、Java、C++、Go、Rust等30余种主流编程语言，可生成API参考文档、模块说明文档、类文档、函数文档等多种类型的技术文档，输出格式支持Markdown、HTML、ReDoc、OpenAPI等标准文档格式。

## 核心功能

1. **智能代码解析**：自动识别代码结构、提取关键信息，包括函数名、参数列表、返回值类型、异常处理、依赖关系等。

2. **注释提取与转换**：深度理解JSDoc、DocString、Doxygen等主流注释规范，将开发者编写的注释内容智能转换为文档描述。

3. **多格式输出**：支持Markdown、HTML、Swagger UI、ReDoc等多种文档展示格式，满足不同场景需求。

4. **代码示例生成**：根据函数签名自动推断可能的调用场景，生成配套的使用示例代码。

5. **批量文档生成**：支持一次性处理整个项目或指定目录，批量生成完整项目文档。

## 调用步骤

**第一步：准备源代码**
将需要生成文档的源代码复制到对话中，可以是完整的文件内容或指定的代码片段。建议确保代码中包含完整的函数定义和必要的注释信息。

**第二步：说明文档需求**
明确告知需要生成的文档类型和输出格式，例如“生成API参考文档，输出Markdown格式”或“为这个模块生成技术说明文档”。

**第三步：执行生成**
工具将自动解析代码结构，识别关键元素，并按照预设的文档模板生成标准化文档内容。

**第四步：审阅与调整**
生成的文档会直接输出到对话中，用户可查看文档内容，如需调整可继续对话修改。

## 输入要求

1. **编程语言**：明确标注源代码所使用的编程语言。
2. **代码完整性**：提供的代码应包含完整的函数或类定义，片段代码可能影响生成质量。
3. **注释规范**：建议使用标准注释格式（如JSDoc、DOCSTRING等），以获得更准确的文档描述。
4. **编码格式**：请使用UTF-8编码的代码文本。

## 输出规范

生成的文档将遵循以下结构规范：

- **概述（Overview）**：模块或类的功能简介
- **语法（Syntax）**：函数或方法的完整签名
- **参数说明（Parameters）**：各参数的类型、含义及默认值
- **返回值（Returns）**：返回值的类型和含义描述
- **异常说明（Throws）**：可能抛出的异常类型及触发条件
- **使用示例（Examples）**：典型调用场景的示例代码
- **注意事项（Notes）**：使用时的重要提示

## 注意事项

1. **代码质量依赖**：生成的文档质量直接依赖于源代码中注释的完整性和准确性，请确保关键逻辑已有清晰的注释说明。

2. **业务逻辑说明**：对于复杂的业务逻辑或特殊实现细节，建议在代码注释中补充说明，工具将优先采用注释内容作为文档描述。

3. **安全敏感信息**：请勿在提交生成文档的代码中包含密码、密钥、认证令牌等敏感信息，系统会自动过滤但建议提前检查。

4. **生成限制**：单次调用建议控制在5000行代码以内，超大项目建议分模块提交处理。

5. **结果验证**：自动生成的文档应作为初稿使用，实际应用前请由熟悉代码的开发者审核确认文档准确性和完整性。

## 适用场景

- 新项目初始化时的文档框架搭建
- 遗留代码的文档补充与完善
- 开源项目的README和API文档编写
- 团队内部技术文档规范化整理
- 快速生成接口文档供前后端对接使用