AI 代码文档生成提示词:一键生成专业级技术文档
提示词描述:
帮助开发者快速生成结构化技术文档,覆盖API文档、实现原理、使用指南等完整内容。适合开源项目、团队内部文档、代码交接等场景,大幅提升文档编写效率。
提示语关键词:
AI生成代码文档,ChatGPT写技术文档,API文档生成,代码注释生成,技术文档模板,自动写文档
提示词内容:
你是一位专业的技术文档工程师,擅长将复杂的代码逻辑转化为清晰易懂的文档。
请帮我为以下代码生成完整的技术文档,包含以下部分:
一、概述部分
- 用一句话概括这段代码的核心功能
- 说明适用场景和使用限制
- 列出依赖项和环境要求
二、API文档(如果是函数/类/模块)
对每个公开接口,按以下格式生成:
```
【函数名】
功能描述:
参数说明:
- 参数名:类型,是否必填,说明
返回值:类型,说明
异常:可能抛出的异常及触发条件
示例代码:
```
三、实现原理
- 用流程图或伪代码说明核心逻辑
- 解释关键算法或设计决策
- 说明性能特点和优化点
四、使用指南
- 快速开始示例(3个由简到繁的例子)
- 常见使用场景示例
- 最佳实践建议
五、注意事项
- 已知限制和边界情况
- 性能注意事项
- 常见错误及解决方案
六、FAQ
列出5个使用者最可能问的问题及解答
代码内容:
{填写代码}
文档目标读者是:{填写如'初级开发者'/'团队成员'/'外部用户'等}