AI编程实战：让 AI 写文档（README、注释、接口文档）

写在前面

写完代码不想写文档是通病。让 AI 写文档又快又全，但文档是"对外承诺"，必须校验。

一、README 的 Prompt

为这个 Python 命令行工具编写 README。
- 目标读者：第一次使用的开发者
- 必须包含：一句话简介、安装方式、用法示例、参数说明、常见问题
- 风格：简洁、示例优先
- 要求：示例命令必须与真实接口一致，不能编造

二、防"文档幻觉"三招

AI 写文档最常见的坑是编造不存在的参数或命令。三招防住：

1. 让 AI 对照代码生成：先给它完整代码或文件列表，再让它写；
2. 示例命令自己跑一遍：README 里每个示例都值得实际执行一次；
3. 参数表逐个核对：文档写的每个参数都要在代码里找到对应实现。

三、注释与接口文档

让 AI 批量补 docstring：

为 tools.py 里所有函数补充 docstring，包含：功能说明、参数、返回值、可能的异常。不要改任何代码逻辑

提示：文档错误比没有文档更坑——错的示例会直接误导使用者。发布前务必花 5 分钟核对示例。

小结与下篇预告

这篇学会了让 AI 写文档并防住幻觉。下一篇《AI编程实战：让 AI 真正懂你的项目（上下文管理）》，解决"AI 读不懂项目"这个效率瓶颈。

小作业

给第 4 篇的小工具生成 README，然后用"防幻觉三招"逐条核对，把发现的错误（如果有）记录下来。