让AI替我读懂代码

目录

• 一个实际场景
• 我做了什么
• 为什么这么做
• 效果
• 说到底

一个实际场景

一周前接手一个Python后端项目，上万行，几十个文件，没有文档，没有测试，README写的部署步骤指向一个打不开的Wiki链接。需要在三天内熟悉系统并接手后续开发。

我能选的路无非两条：硬读代码，一行一行啃；或者想办法让工具帮我加速。我选了后者。

我做了什么

写了两个提示词。

第一个：让AI读取整个项目源码，生成一份交互式HTML可视化文档。左侧是文件树，右侧是每个文件的分析——方法功能、执行步骤、技术标签、源码引用，还有"新手易懂版"和"专有名词版"两种概述切换。

第二个：每次让AI改代码之前先喂给它的"行为规则"。规定它不要过度设计、不要顺手改无关代码、不要创建不必要的抽象层。简单说就是——用最少代码、改最少地方、完成当前任务。

为什么这么做

我的想法很简单：AI写代码的能力已经很成熟了，但怎么让它按我的标准输出，这件事需要明确约束。

所以我的提示词里没有"请你帮我分析代码"这样模糊的指令，而是写清楚：

• 每个方法必须列出执行步骤，用参数/赋值/执行/返回/条件/循环/异常/调用这些中文标签标注
• 关键操作必须贴源码原文，不能只写抽象描述
• 每个文件的概述各自独立，即使功能相似也分别写，不共用模板
• 所有交互用事件委托，不用inline onclick（否则AI生成的HTML会出现点击无效的bug）

这些规则看起来琐碎，但每一条都是实际踩过坑之后的沉淀。不是教AI怎么写代码，是告诉它：我要的是我能看懂的东西，不只是能跑的东西。

效果

用第一个提示词，三天摸清了整个系统，比预期提前两天。

用第二个提示词，日常改代码的diff变得干净精准，Code Review时间大幅缩短。

两份提示词本身都是纯文本，没有技术门槛，替换路径就能直接用。

（ps： 涉及公司 这里我就不把效果展示出来了 修修改改后 亲测效果还行
感兴趣的朋友可以去试试 根据自己的项目复杂度去试 注意很复杂就会有点费token）

说到底

我做这件事的核心逻辑是：把AI当作一个能力很强但需要明确规则的合作者。你给它的约束越清晰，它给你的结果越可用。

与其教它怎么做，不如告诉它你要什么、不要什么。

---

以上所有提示词和这篇博客都放在：

https://github.com/black-mouse-sha/prompt

有类似场景的朋友可以直接取用，替换项目路径就行。