代码解释 · 程序员
用 AI 智能体做这件事
接手别人的老代码,最怕看不懂它到底在干什么。这个场景先声明语言与框架版本、代码托管平台与团队规范,再把一段代码逐段拆开讲清:它在做什么、数据怎么流转、哪里写得绕或有坑,并给一个典型输入下的执行过程。上下文没给全的部分会标【待补】,不会替它编。
你需要准备
- 语言与框架版本(如 Python 3 + Django 4),版本不同解释口径会不一样
- 代码托管平台与协作流程(GitHub / GitLab / 内部仓库),方便对齐仓库上下文
- 待解释的代码(函数或模块,尽量带上依赖与调用方)
- 团队代码规范 / 命名规则(涉及「写得绕」的判断时)
- 一个典型输入示例(用于演示执行过程,没有的话标【待补】)
怎么做
- 先声明语言与框架版本、托管平台与团队规范
- 若代码含密钥、token 或数据库连接串,先脱敏再粘贴
- 把代码与一个典型输入发给 AI,粘贴提示词
- 核对【待补】清单,补上缺失的调用方或依赖后再让它复述一遍
一句话提示词
下面这段代码是我接手的老项目里的【语言,如 Python】代码,语言与框架版本、代码托管平台(GitHub / GitLab / 内部仓库)和团队代码规范我先声明,帮我逐段解释它在做什么、数据怎么流转,标出写得绕或有坑的地方,最后用大白话讲一遍整体逻辑,并举一个典型输入下的执行过程;我没贴全的调用方代码或依赖请标【待补】,不要编造。
它会交付什么
- 逐段解释:每段在做什么、数据怎么流转
- 写得绕或有坑的地方清单(属 AI 归纳,需人工判断)
- 大白话整体逻辑 + 一个典型输入下的执行过程
效果示例
输入一个约百行的 Flask 下单接口(未附调用方)→ 输出逐段解释与 3 处坑;「调用方代码未给」被列入【待补】清单。
常见问题
不告诉语言和框架版本行吗?
不建议。版本不同,写法的含义和坑也可能不同,先声明版本解释才准。
代码里有密钥能直接发吗?
不行,先把密钥、token、连接串脱敏,这是前置步骤。
一次能解释多长的代码?
建议一个函数或模块(约一两百行)一批,太长容易被略读,请分段。
会不会自己补充没给的信息?
不会。缺的上下文标【待补】,不给它脑补,判断处也标了需人工判断。