用Codex检查README与代码一致性需先提取文档中的接口级功能描述并生成代码行为摘要,再通过分屏比对或Codex辅助识别遗漏、数值不一致及文档缺失等问题,且所有发现必须回代码验证。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

用Codex检查README是否与代码一致,需要借助其代码理解能力逐项比对文档描述和实际实现,不能只靠关键词匹配,否则会漏掉逻辑偏差或过时注释。
提取README中的功能声明
打开README.md文件,通读全文,用鼠标选中所有明确描述「功能」「支持什么输入」「返回什么结果」「依赖哪些模块」的段落,复制到剪贴板。注意跳过「欢迎语」「作者信息」「安装步骤」这类无关内容,【只保留接口级、行为级描述】。
把选中的文本粘贴进新建的临时文本文件,命名为readme-spec.txt。
生成代码行为摘要
在VS Code中安装CodeLLM插件(或使用GitHub Copilot Chat),右键点击项目根目录下的主入口文件(如main.py、index.js或src/App.tsx),选择「Ask Codex: Summarize this file」。
等待Codex返回结构化摘要,重点提取:导出的函数名、参数类型、返回值说明、调用的关键外部模块、处理的核心数据流。如果摘要含糊,追加提示:“用一句话说明这个文件对外暴露了哪些可调用行为”。
将来自 Marvis 或微信的可信远程软件开发请求中继至用户本地的 Codex CLI,等待编码任务完成,并返回经验证的结果。当用户通过 Codex 要求 Marvis 检查、实现、修复、测试、review 或继续在明确指定的本地项目目录中开展工作时,使用此功能。
将Codex输出的摘要粘贴到另一个临时文件code-behavior.txt中,删掉解释性语句,只留客观行为陈述,例如:“parseConfig()接收string路径,返回object配置;validateInput()接收number数组,抛出Error或返回true”。
逐条人工比对差异点
方法一:左右分屏对照
左侧打开readme-spec.txt,右侧打开code-behavior.txt,逐行检查:
- README说“支持JSON/YAML双格式解析”,但code-behavior里只提到loadJson(),没提YAML相关函数 → 存在遗漏
- README写“默认超时30秒”,code-behavior中却显示timeoutMs=15000 → 数值不一致
- README未说明错误码含义,code-behavior里列出ERR_TIMEOUT、ERR_PARSE → 文档缺失
方法二:用Codex辅助查漏
把readme-spec.txt全部内容作为上下文,向Codex提问:“根据以上README描述,请列出当前代码中不存在、但文档声称支持的功能点”,Codex会返回缺失项清单。注意验证它的回答——它可能虚构函数名,【必须回到代码里搜索确认是否存在】。










