文档生成
简介
自动生成代码文档、API 说明和技术文档，保持文档与代码同步。
使用场景
- 函数/类级注释生成
- API 接口文档（OpenAPI/Swagger）
- README 编写与维护
- 技术方案文档
提示词模板
请为以下代码生成完整的技术文档：
【代码】： [代码内容]
【文档类型】：[API文档/使用说明/架构文档] 【受众】：[内部开发者/外部用户/运维人员]
要求：
- 功能概述（一句话说明用途）
- 参数说明（类型、必填、默认值、含义）
- 返回值说明（类型、结构、异常情况）
- 使用示例（含输入输出）
- 注意事项与限制
- 相关链接（如有）
风格：[简洁/详细/教程式]
进阶技巧
- 指定文档标准（如 JSDoc、Swagger、Markdown）
- 要求包含边缘情况和错误码说明
- 对复杂逻辑要求补充流程图或时序图描述