代码注释和文档一次生成，告别下班补注释

贴一段代码，AI 生成行内注释、函数说明和使用文档，接手的同事看得懂。

提示词（点复制，直接发给 AI）

示例1

帮我用通义千问写一封工作邮件，收件人是部门领导王总，我因为孩子生病需要请假两天，语气正式但不生硬，要表达歉意并说明工作交接安排。

示例2

请用ChatGPT帮我整理以下会议记录，提取关键决策和待办事项，要求用表格形式呈现，每个待办事项注明负责人和截止日期。

示例3

用豆包帮我翻译这段中文内容成英文，要求保持原文语气，使用地道表达，适合正式场合使用。原文：[粘贴内容]

模板

这是我的{{代码类型}}，请帮我生成{{文档类型}}。要求如下：

1. 注释写{{注释重点}}

2. 包含{{文档内容}}

3. 格式用{{格式}}

输出格式：{{格式}}。

参考选项：

- {{代码类型}}：Python函数 / 接口代码 / 一个类

- {{文档类型}}：行内注释 / 接口文档 / README段落

- {{注释重点}}：解释为什么 / 标注坑

- {{文档内容}}：使用示例 / 参数表 / 错误码

- {{格式}}：Markdown 文档 / 行内注释版 / 表格版

填好的示例

这是我的Python函数，请帮我生成行内注释。要求如下： 1. 注释写解释为什么 2. 包含使用示例 3. 格式用Markdown 文档输出格式：Markdown 文档。

已把参考选项的第一组填进模板，复制后改数字、细节就能直接发给 AI。

怎么用：三步。① 贴代码并说明类型；② 检查注释有没有说错逻辑；③ 让 AI「再补一段边界情况说明」。

适用模型：ChatGPT / GPT-4 / Claude / 通义千问 / Kimi

适用场景：交接代码；写接口文档；开源项目补README

【相关推荐】
sql-opt

还想看更多？ChatGPT 提示词模板里还有一批能直接抄的。