ChatGPT把旧代码整理成说明文档提示词应该写哪些限制条件-人工智能-PHP中文网

必须锁定输入源与输出边界：【】明确圈出待处理代码块，禁止虚构调用、遗漏分支、误用废弃函数，严格按实际逻辑生成技术文档。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

chatgpt把旧代码整理成说明文档提示词应该写哪些限制条件

你需要把一段旧代码快速转成可交付的技术文档，但ChatGPT每次生成的说明要么漏掉关键逻辑分支，要么混入虚构的调用场景，甚至把已废弃的函数当主流程写。这说明提示词里缺了真正管用的限制条件，不是加个“请写清楚”就能解决。

必须锁定输入源与输出边界

第一步：在提示词开头用【】明确圈出待处理代码块，例如【

def legacy_calc(x, y):\n    if x 】。不加这个分隔符，模型可能把你的指令文字误判为代码注释内容。<p>第二步：强制声明“仅基于【】内代码生成文档，禁止推测、补充、虚构任何未出现的变量名、函数调用或业务规则”。旧代码常有残缺逻辑，模型容易自动“补全”，这一句能拦住90%的胡编乱造。</p><p>第三步：写明“若代码中存在明显语法错误或缺失定义（如调用未声明的func_a），须如实标注‘此处原始代码不可执行’，不得自行修复或绕过”。这是保真底线，不是可选项。</p><h2>格式与结构必须硬性嵌套</h2><p>方法一：用字段级指令代替模糊要求。不要说“包含参数说明”，要说“参数说明字段必须列出每个形参名称、类型（从代码中推断）、是否可为空、在函数体内的首次使用位置（行号）”。</p><div class="aritcle_card flexRow artxards">
											<div class="artcardd flexRow">
												<a class="aritcle_card_img" rel="nofollow" href="/xiazai/skill3509" title="Ask Gemini/ChatGPT"><img
														src="https://img.php.cn/upload/skill/000/000/081/178964107627042.jpg" alt="Ask Gemini/ChatGPT" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
												<div class="aritcle_card_info flexColumn">
													<a rel="nofollow" href="/xiazai/skill3509" title="Ask Gemini/ChatGPT" class="overflowclass">Ask Gemini/ChatGPT</a>
													<p class="overflowclass">用于在用户想通过浏览器自动化与 Google Gemini 或 ChatGPT 交互时。触发短语包括“ask Gemini”“ask ChatGPT”“ask GPT”“让...”。</p>
												</div>
												<a rel="nofollow" href="/xiazai/skill3509" title="Ask Gemini/ChatGPT" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
												</a>
											</div>
										</div><p>方法二：返回值部分必须区分“实际返回值”和“隐式返回值”。例如Python中无return语句的函数实际返回None，必须单独写一行：“隐式返回值：None（因末尾无return语句）”。<strong>【漏掉隐式返回值是旧代码文档最常见致命错误】</strong></p><p>方法三：错误处理路径必须单列。凡代码中出现if xxx is None: raise ValueError(...)这类结构，必须提取为“触发条件｜抛出异常类型｜异常消息关键词”三列表格，不接受段落描述。</p><h2>禁用一切泛化表达</h2><p>禁止使用“通常”“一般情况下”“可能涉及”等模糊限定词，所有陈述必须可追溯至代码字面。例如不能写“该函数通常用于数值计算”，而要写“该函数仅在main.py第42行被调用，传入参数来自user_input.get_int()”。</p><p>禁止添加背景解释。不许写“由于历史原因，该函数未使用类型提示”，只允许写“代码中无类型注解”。<strong>【加解释=开脑补口子】</strong></p><p>每项说明后必须附带原始代码行引用，格式为[Ln12-15]。没有引用行号的内容视为无效输出。</p>