必须严格按指定格式处理代码:限定输入范围,禁用猜测;三级标题结构或执行流/表格任选其一;跳过调试语句与日志;todo单独汇总;术语首次出现需括号直白解释;禁用模糊表述,保留英文变量名。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让Gemini把一段旧代码自动整理成清晰、可读、带上下文的说明文档,但直接丢代码过去往往生成空泛或错漏百出的内容——因为模型不知道你关心什么函数、忽略哪些调试日志、是否要保留原始注释风格、要不要画流程图文字描述。
限定输入范围与格式
在提示词开头明确声明:只处理你提供的代码块,不联网、不猜测缺失文件、不补全未给出的类定义。如果代码中引用了外部模块(如utils.py),必须写明“该文件未提供,不作解释”。【否则Gemini会虚构函数逻辑,导致文档完全失真】
要求代码以```python或```java等语言标识符包裹,禁止粘贴无格式纯文本代码段。
指定文档结构层级
方法一:强制三级标题体系
用“# 模块概览 → ## 核心函数 → ### 参数说明”结构输出,每级标题下不许空行,函数名必须与源码def/func行完全一致(包括大小写和下划线)。
方法二:按执行流组织
第一步:识别主入口函数(找含if __name__ == "__main__":或main()调用的函数)
第二步:从该函数出发,逐层列出被直接调用的函数(不展开间接调用)
第三步:对每个列出的函数,仅说明“作用+输入类型+返回类型”,不写实现细节
方法三:表格优先
生成一张表,列名为【函数名】【所在文件】【用途简述】【关键副作用(如写文件、发HTTP)】,空单元格填“无”,不许留空。
过滤无关内容
跳过所有以# DEBUG、// TEMP、/* test_only */开头的行,无论是否在函数体内。
忽略所有print()、console.log()、logger.debug()调用语句,不解释其意图,不归入“功能说明”。
若代码含TODO/FIXME注释,单独汇总为“待办事项”小节,原样保留文字,不翻译、不润色、不补充解决方案。
术语与风格约束
所有技术名词(如JWT、LRU、idempotent)首次出现时,在括号内给出不超过10字的直白解释,例如“JWT(令牌认证)”。【避免堆砌缩写却不说明,导致新成员看不懂】
禁用“我们建议”“可以考虑”“通常情况下”等模糊表述;改用“必须校验token有效期”“此处硬编码了超时值3000ms”。
中文文档中保留原始代码里的英文变量名(如user_id、is_active),不翻译为“用户编号”“是否启用”。











