首页/AI 提示词库/编程开发/代码解释与注释

代码解释与注释

⌨ 编程开发 适配:通用(GPT / Claude / 通义 / DeepSeek)难度:入门 3 个变量一键复制
使用说明

逐段讲清代码在做什么、为什么这么写、有哪些坑,并补上可维护的注释。

接手老项目、读开源库、给团队做代码讲解。

提示词模板未填写变量以红色标出
请解释下面这段代码。

【代码】{{代码}}
【语言与框架】{{语言与框架}}
【我的熟悉程度】{{我的熟悉程度}}

要求:
1. 先用 3 句话说明这段代码的整体职责,不要逐行复述。
2. 按逻辑块拆解,每块说明:做什么、为什么这么写、如果去掉会怎样。
3. 标出 3 个最容易踩坑的地方(边界条件、异常路径、隐式类型转换、异步时序等)。
4. 指出可以改进的 2-3 处,说明改进带来的具体收益(可读性 / 性能 / 健壮性),不要为了改而改。
5. 最后给一版带注释的代码,注释只写「为什么」,不写「做了什么」。
6. 不确定的运行时行为要明确标注「需实测验证」,不要臆断。
填变量变量会自动替换进上方模板,可随时复制
已填 0 / 3
使用步骤
  1. 贴代码时保留原始缩进与导入,缺上下文会让解释失真。
  2. 先看整体职责那三句,确认理解一致再看细节。
  3. 把「容易踩坑」清单存进项目笔记,下次改这块前先看。
注释写为什么
「i 加一」是废话,「跳过表头」才有价值。
先问职责再问细节
一上来逐行解释,往往会解释错整体意图。
常见问题
代码太长放不下怎么办?

按文件或函数分批贴,先让它建立整体结构认知再深入。

它能发现真正的 bug 吗?

能发现常见的逻辑与边界问题,但并发与时序问题仍需实测。