AI制造局 提示词 · 本局出品
← 返回首页
程序员在电脑上写代码注释的场景,用于代码文档提示词

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

更新于 2026年8月11日 分类:编程开发 更多提示词 →

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

提示词(点复制,直接发给 AI)

示例1
这是我的一段 Python 函数,请为每个函数和关键行添加中文注释。要求:注释解释「为什么」而不是「是什么」;给出函数的使用示例;标注可能的坑。
示例2
这是我的接口代码,请生成一份接口文档。要求:包含请求参数表、响应示例、错误码说明;用 Markdown 表格。
示例3
这是我的一个类,请生成 README 里的一段使用说明。要求:给安装方式、最小可用示例、常见问题。

想自己改?模板+参考

模板
这是我的{{代码类型}},请帮我生成{{文档类型}}。要求如下:

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

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

3. 格式用{{格式}}

输出格式:{{格式}}

参考选项:

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

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

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

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

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

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

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

使用说明

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

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

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

返回首页继续找提示词 浏览全部分类
分享这篇提示词: 微博 QQ空间 微信:复制链接发给朋友即可
AI 制造局 · 提示词工坊

一个人工整理的中文提示词库。每篇都按「示例+模板+参考选项+使用说明」的标准出厂,提示词经实际使用验证;内容由本站编辑撰写,欢迎按自己的场景改造成更好用的版本。

发表评论