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

阿芳吖_2457

阿芳吖_2457

2026-06-01

212人浏览

原创

必须严格按指定格式处理代码:限定输入范围,禁用猜测;三级标题结构或执行流/表格任选其一;跳过调试语句与日志;todo单独汇总;术语首次出现需括号直白解释;禁用模糊表述,保留英文变量名。

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

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

你需要让Gemini把一段旧代码自动整理成清晰、可读、带上下文的说明文档,但直接丢代码过去往往生成空泛或错漏百出的内容——因为模型不知道你关心什么函数、忽略哪些调试日志、是否要保留原始注释风格、要不要画流程图文字描述。

限定输入范围与格式

在提示词开头明确声明:只处理你提供的代码块,不联网、不猜测缺失文件、不补全未给出的类定义。如果代码中引用了外部模块(如utils.py),必须写明“该文件未提供,不作解释”。【否则Gemini会虚构函数逻辑,导致文档完全失真】

要求代码以```python或```java等语言标识符包裹,禁止粘贴无格式纯文本代码段。

指定文档结构层级

方法一:强制三级标题体系
用“# 模块概览 → ## 核心函数 → ### 参数说明”结构输出,每级标题下不许空行,函数名必须与源码def/func行完全一致(包括大小写和下划线)。

方法二:按执行流组织
第一步:识别主入口函数(找含if __name__ == "__main__":或main()调用的函数)
第二步:从该函数出发,逐层列出被直接调用的函数(不展开间接调用)
第三步:对每个列出的函数,仅说明“作用+输入类型+返回类型”,不写实现细节

方法三:表格优先
生成一张表,列名为【函数名】【所在文件】【用途简述】【关键副作用(如写文件、发HTTP)】,空单元格填“无”,不许留空。

过滤无关内容

跳过所有以# DEBUG、// TEMP、/* test_only */开头的行,无论是否在函数体内。

忽略所有print()、console.log()、logger.debug()调用语句,不解释其意图,不归入“功能说明”。

Baoyu Danger Gemini Web
Baoyu Danger Gemini Web

通过逆向工程的Gemini网页API生成图像和文本。支持文本生成、提示词图像生成以及用于视觉输入的参考图像等。

下载

若代码含TODO/FIXME注释,单独汇总为“待办事项”小节,原样保留文字,不翻译、不润色、不补充解决方案。

术语与风格约束

所有技术名词(如JWT、LRU、idempotent)首次出现时,在括号内给出不超过10字的直白解释,例如“JWT(令牌认证)”。【避免堆砌缩写却不说明,导致新成员看不懂】

禁用“我们建议”“可以考虑”“通常情况下”等模糊表述;改用“必须校验token有效期”“此处硬编码了超时值3000ms”。

中文文档中保留原始代码里的英文变量名(如user_id、is_active),不翻译为“用户编号”“是否启用”。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

gemini

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
WorkBuddy核心功能与实操模式
WorkBuddy核心功能与实操模式

深入探索WorkBuddy的强大功能。本专题包含智能问答、文档处理、会议纪要生成、日程管理、任务协作等核心模块的操作指南与最佳实践。通过图文并茂的教程,助您快速上手,最大化发挥WorkBuddy的办公效能。

2026.04.09

622

19

Gemini网页版零基础入门:5分钟上手Gemini聊天指南
Gemini网页版零基础入门:5分钟上手Gemini聊天指南

本专题专为零基础用户打造,5分钟快速掌握Gemini网页版核心用法。从账号登录到界面布局,详解如何发起对话、优化提示词及利用多模态功能。通过实战案例,教你高效获取信息、创作内容与分析数据。无论学习还是工作,轻松开启AI辅助新时代,让Gemini成为你的得力智能助手。

2026.03.18

18197

10

如何写出高效Gemini提示:Chain of Thought实用教程
如何写出高效Gemini提示:Chain of Thought实用教程

本专题详解如何利用“思维链”(Chain of Thought)技巧激发 Gemini 模型的深度推理能力。通过引导模型将复杂问题拆解为逐步推导的逻辑链条,显著提升其在数学计算、代码生成及逻辑分析任务中的准确率。文章提供实用提示模板与对比案例,助您掌握结构化提问方法,从简单指令升级为高效交互,轻松获取更精准、可解释的智能回答。

2026.03.23

57

10

Gemini多模态实战:图片PDF视频输入完整处理指南
Gemini多模态实战:图片PDF视频输入完整处理指南

本指南全面解析 Gemini 多模态实战,涵盖图片、PDF 及视频的高效处理流程。从上传技巧到提示词设计,教您如何提取文档关键信息、分析图表数据及解读视频内容。通过真实案例演示,助您掌握跨模态交互核心技能,轻松构建智能文档分析与多媒体理解应用,释放 AI 潜能。

2026.03.23

77

10

Gemini提示工程进阶:Few-shot与角色扮演优化方法
Gemini提示工程进阶:Few-shot与角色扮演优化方法

本进阶指南深入解析 Few-shot 学习与角色扮演在 Gemini 提示工程中的核心应用。通过精选示例引导模型模仿特定风格,结合角色设定规范输出语气与逻辑,显著提升复杂任务的处理精度。文章提供实用模板与调优策略,助您打造个性化 AI 助手,实现从通用回答到专业级交互的质的飞跃。

2026.03.23

96

10

Google AI Studio使用教程:从模板到自定义Prompt实战
Google AI Studio使用教程:从模板到自定义Prompt实战

本教程手把手教您掌握 Google AI Studio,从快速调用官方模板到深度自定义 Prompt 实战。内容涵盖界面导航、参数调优及版本管理,助您灵活构建专属 AI 应用。通过真实案例演示,让您轻松实现从创意构思到原型部署的全流程,高效释放 Gemini 模型潜能,打造智能化解决方案。

2026.03.23

121

12

Gemini API快速上手:Python调用generateContent完整指南
Gemini API快速上手:Python调用generateContent完整指南

本指南详解如何使用 Python 快速调用 Gemini API 的 generateContent 方法。从环境配置、密钥管理到核心代码实现,逐步演示文本生成、多模态输入及流式响应处理。包含完整示例与错误排查技巧,助开发者轻松集成 Gemini 强大能力,构建高效智能应用,开启 AI 开发新篇章。

2026.03.23

110

11

如何实现Gemini函数调用:Tool Use与外部工具集成教程
如何实现Gemini函数调用:Tool Use与外部工具集成教程

本教程深入解析 Gemini 函数调用机制,详解 Tool Use 配置与外部工具集成流程。从定义函数架构到处理动态参数,手把手教您连接数据库、搜索 API 及自定义服务。通过实战案例,展示如何让 AI 自主规划并执行复杂任务,突破纯文本限制,构建具备真实行动力的智能代理系统。

2026.03.23

185

11

Gemini结构化输出JSON模式:API稳定提取数据实战
Gemini结构化输出JSON模式:API稳定提取数据实战

本实战指南详解如何利用 Gemini API 的 JSON 模式实现结构化数据提取。通过配置响应格式约束,确保模型输出严格符合预定义 Schema,彻底解决解析错误难题。内容涵盖字段定义、类型校验及异常处理,助您在信息抽取、数据清洗等场景中构建高稳定性管道,轻松将非结构化文本转化为可靠的应用数据。

2026.03.23

111

13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gemini Notebook常见问题解答
Gemini Notebook常见问题解答

共0课时 | 0人学习

Gemini Notebook官方手册
Gemini Notebook官方手册

共0课时 | 0人学习