ChatGPT提问工程师开发指南：重构代码与生成API文档的高效命令手册
ChatGPT提问工程师开发指南：重构代码与生成API文档的高效命令手册
项目地址: https://gitcode.com/gh_mirrors/ch/chatgpt-query-engineer-handbook ChatGPT提问工程师开发指南是一份专为提升开发效率而设计的实用手册，它收集和整理了与ChatGPT合作编程时常用的命令与问题，帮助开发者在代码重构和API文档生成等任务中更高效地与ChatGPT协作。
🚀 为什么需要ChatGPT提问工程师开发指南
在开发过程中，与ChatGPT的有效沟通至关重要。由于ChatGPT的回答具有开放性和发散性，对于具体的开发任务，需要针对性的提问才能获得期望的结果。本指南通过提供经过实践检验的命令，帮助开发者提高提问效率，让ChatGPT成为更得力的开发助手。
命令稳定性说明
命令稳定性代表ChatGPT回答符合期望的程度，分为强、中、弱三个等级：
- 强：尝试10次，>8次符合期望
- 中：尝试10次，>5次符合期望
- 弱：尝试10次，>2次符合期望 默认值为强。
明确处理内容的方法
为了让ChatGPT准确识别需要处理的内容，可以采用以下方法：
- 一般通过换行即可区分命令和内容
- 用「」{}等符号将内容圈起来
- 明确说明需要处理的内容，如“优化「」中的文案”
🔧 代码重构的高效命令
代码重构是提升代码质量的重要环节，以下是几个实用的重构命令。
基础重构命令
refactor the code
此命令稳定性为强，适用于对代码进行基本的重构优化。
带格式展示的重构命令
Refactor the code to present the changes in vimdiff format and explain the changes in Chinese
该命令不仅能对代码进行重构，还会以vimdiff格式展示更改内容，并使用中文解释更改，方便开发者清晰了解重构细节。
📝 生成API文档的实用命令
清晰的API文档对于项目的维护和使用至关重要，以下命令可帮助生成高质量的API文档。
生成中文API文档
Generate markdown API Chinese documentation
此命令稳定性为中，能生成Markdown格式的中文API文档。需要注意的是，由于每次生成结果可能不同，在开发迭代中维护文档时，可能需要进一步摸索更稳定的方式。
💡 使用命令的附加技巧
所有命令都可以添加任意附加条件，这也是ChatGPT和传统API调用最大的不同之处。附加条件可以非常抽象，例如：
优化「」中的文案，扩充到 300 字
「该指南旨在帮助 ChatGPT提问工程师 提高提问效率」
此外，ChatGPT具备上下文理解能力，可以对之前的对话内容直接进行提问，但需要注意控制，避免在连续提问中迷失最初的需求目标。
📚 相关资源推荐
通过本指南提供的命令和技巧，开发者可以更高效地利用ChatGPT进行代码重构和API文档生成等开发任务，提升开发效率和质量。欢迎大家补充更多实用的命令，共同完善这份指南。
如果需要使用本项目，可通过以下命令克隆仓库：
git clone https://gitcode.com/gh_mirrors/ch/chatgpt-query-engineer-handbook
汇聚全球AI编程工具，助力开发者即刻编程。
更多推荐
6
0- 0
已为社区贡献14条内容
所有评论(0)