【输入】一段无注释的Python函数,含3层嵌套循环+异常处理块;【输出】一份Markdown格式说明文档,包含函数用途、参数说明、核心逻辑流程图(文字版)、关键分支条件解释、已知限制三部分。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要把一段没有注释、逻辑嵌套深、变量命名随意的旧Python代码,自动转成开发者能快速看懂的技术说明文档,而不是简单翻译成中文或加几行注释。
明确输入与输出边界
第一步:在提示词开头用【输入】和【输出】显式划清范围。例如写:“【输入】一段无注释的Python函数,含3层嵌套循环+异常处理块;【输出】一份Markdown格式说明文档,包含函数用途、参数说明、核心逻辑流程图(文字版)、关键分支条件解释、已知限制三部分。”
这一步漏掉会导致模型自由发挥——它可能把代码重写一遍,或只生成一段笼统的“该函数用于数据处理”之类无效描述。
强制结构化输出格式
方法一:用带编号的区块指令
① 函数概述:用一句话讲清“谁在什么场景下调用它,达成什么业务目标”,禁止出现“实现功能”“进行处理”等空泛动词;
② 参数表:必须按“参数名|类型|是否必填|说明(含默认值含义)”五列表格呈现,空参数也要写“无”;
③ 执行路径:用缩进箭头(→)描述主干流程,每层缩进代表一次if/for/try嵌套,箭头后只写触发条件或动作结果,不写代码行号;
④ 注意事项:单独列出原始代码中未处理的边界情况(如空列表、None输入、超长字符串),并标注“当前版本未防御”;
⑤ 依赖说明:提取import语句中非标准库模块,写明最低兼容版本(如requests≥2.28.0)。
统一LLM网关 - 一个API对接70+AI模型,使用单一API密钥即可调用GPT、Claude、Gemini、Qwen、Deepseek、Grok等主流模型。
方法二:直接指定Markdown二级标题锚点
要求输出必须包含且仅包含以下5个
标题:? 功能定位
? 参数契约
⚙️ 主干流程
⚠️ 隐患清单
? 运行依赖
。任意缺失一个标题,整份文档即视为不合格。
约束旧代码理解深度
添加三项硬性限制:
第一,禁止推测意图:当代码中出现magic number(如if status == 42:)且无上下文时,必须写“此处42的业务含义未在代码中体现,需查阅历史PR#287确认”,不能自行解释为“表示审核通过”;
第二,变量名照搬不翻译:原始变量名tmp_lst不得改写为“临时列表”,保持原样出现在参数表和流程描述中;
第三,【遇到正则表达式、SQL拼接、base64解码等敏感操作时,必须单独增加‘安全观察’小节,指出是否校验输入长度、是否过滤特殊字符、是否使用预编译】。
控制技术细节粒度
加入两条反模糊指令:
“不许使用‘相关逻辑’‘部分代码’‘某些条件下’等模糊指代,所有描述必须绑定到具体代码行(如第47行while循环)或具体变量(如retry_count);”
“当函数调用另一个未提供源码的函数时,写‘委托至utils.normalize()(源码不可见)’,禁止虚构其行为。”


















