ChatGPT写代码注释怎么用:说明已有行为与约束(2026)
ChatGPT 写代码注释怎么用?它只为已经存在的代码补充人能读懂的说明:这段为什么存在、输入输出是什么、有哪些边界和副作用。禁止把注释写成尚未实现的功能,或编造「已处理所有异常」。它不是解释代码(给读者写讲解),也不是代码审查、Git 提交说明或README。注释跟代码走,讲解、审查和文档走另外的页面。
本页速答
| 你想做的事 | 怎么写 / 怎么做 | 发出或采用前必核 |
|---|---|---|
| 贴出真实代码 | 需要注释的函数、模块或关键片段 | 是否在注释里描述了代码没有的行为 |
| 说明意图与边界 | 为什么这样写、参数约束、返回值、副作用 | 有无编造性能保证或异常处理 |
| 选对注释类型 | 模块说明、函数文档还是关键行注释 | 是否把教程讲解整段写进代码 |
| 不改行为 | 默认只加注释;若要改代码必须你另行确认 | 是否被悄悄改了逻辑 |
| 打假 | 删除未出现的接口、默认值和‘已全面覆盖’ | 每条注释能否在代码里找到依据 |
按钮名与可用范围随版本变化。核对戳:以 chatgpt.com 当期界面为准(2026年11月14日;本站不编造价格与额度)。
要素公式
- ☐ 代码范围:语言、文件或函数,以及你希望的注释风格(如 docstring 或行内)。
- ☐ 已知事实:你确认的意图、限制、调用约定;没有的标【待核】。
- ☐ 输出:注释文本或带注释的同一段代码,不扩展新功能。
- ☐ 禁区:不把审查意见、提交说明或 README 用法写成注释。
若你需要向同事讲解这段代码,用解释代码;要找问题,用代码审查。
可复制模板
注释骨架:
“请用简体中文(代码标识符保持原文)为下面的代码写注释,不要写成代码讲解文、代码审查、提交说明或 README。语言与注释风格:【】。代码(不可新增功能、接口、默认行为和异常处理承诺):【粘贴】。我确认的意图与约束:【】。禁止编造未实现行为。输出:建议注释(模块/函数/关键行)、不确定处标【待核】、须核对清单。默认不要改逻辑。”
按原代码回填:
“把确认后的注释放回原代码对应位置,保持原逻辑不变。不要为了‘完整文档’补上代码里不存在的参数或返回值。多余的教程段落删掉。”
打假与同步校对:
“对照代码,删除描述了未实现分支、未捕获异常或未使用参数的句子。若注释与代码冲突,指出冲突并提问,不要擅自改代码。列出合并前须核对的10处。”
第一版后定点追问修改。更多句式见提示词怎么写。
改稿步骤
- 先贴出真实代码和你知道的意图,再生成注释,不要只说「给这个项目补全注释」却不给文件。
- 逐条核对接:注释里的参数、返回值和副作用必须能在代码中找到。
- 只在关键处注释;显而易见的赋值不必逐行翻译。提交记录另用提交说明,不要把注释当 changelog。
对外说明如何安装和使用,请写README,不要把用户手册塞进函数注释。
常见踩坑
- 让模型按理想实现补注释,把还没写的功能写得像已经完成。
- 把解释代码的长文、审查意见或 README 整段贴进源码。
- 默认允许它「顺便重构」,导致行为被改。
- 给每一行都加废话注释,反而降低可读性。
场景补充
好注释解释为什么和边界,而不是把代码再翻译一遍。注释必须和当前代码同步。本站不运行你的程序,也不保证注释完全正确。
工作流补充
粘贴代码与已知意图→生成对应层级注释→与代码逐条对照→冲突标待核后再合并。中文界面见设置中文。
深度补充:注释是对代码的说明,不是对愿望的预告
模型常会写「此函数会校验全部输入并保证线程安全」。代码没做这些,注释就是谎言。提示词须禁止描述未实现行为,缺信息标【待核】。
解释代码面向人类读者的理解路径,审查面向问题清单,提交说明面向一次变更动机,README 面向使用方法——注释只附着在源码旁,帮助下次修改的人。功能以官方为准;注释是否准确要靠你对照代码和测试。
常见问题
可以同时让它改代码吗?
默认不要。先只要注释;若需要修改,另开明确要求并做代码审查和测试。
和解释代码、代码审查有何不同?
解释代码是给读者的讲解;审查是找问题;注释是写进源码的简短说明。
和提交说明、README 怎么分工?
提交说明记录为何修改;README 教人如何使用;注释说明这段代码此刻在做什么、有何限制。
代码自己也看不太懂,能先让它猜吗?
可以先标【待核】的理解,但不要把猜测写成确定注释;先运行或查调用再定稿。
中文注释还是英文注释?
按团队约定。提示词里写明;标识符和对外 API 名称保持原样。
生成了一大段文档字符串怎么办?
只保留与代码一致的输入、输出、副作用和注意事项,删掉教程和未实现承诺。
相关推荐
编辑说明:本文由ChatGPT中文指南编辑部(非官方)整理,2026-11-14 NEW×10 使用向长尾;含本页速答 + FAQ;不编造价格、额度与官方承诺;如与官方页面不一致,以官方为准。