要让Gemini生成高质注释,需从目的、读者、上下文三维度升级提示词:基础版明确“只添加注释,不修改代码”,限定格式;进阶版按读者经验分层并绑定代码锚点;工程版嵌入规范、SLA与自检要求。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

想让Gemini生成的脚本注释既清晰可读又具备工程实用性,不能只写“解释这行代码”,得从注释目的、读者角色、上下文粒度三个维度逐步升级提示词。
基础版:让Gemini知道“这是注释任务”
第一步:在提示词开头明确指令类型,避免模型默认输出完整脚本。【必须包含“只添加注释,不修改/重写代码”】
第二步:提供待注释的代码片段,用```python```等代码块包裹,确保语法结构完整。
第三步:加上一句约束:“每行代码上方或右侧添加中文注释,用#开头,不新增空行。”
实用进阶版:控制注释深度与读者视角
方法一:按读者经验分层提示
给新手看的注释,强调“为什么这么写”;给维护者看的注释,强调“改这里会牵连哪些模块”。例如:“假设阅读者是刚接手项目的Python中级开发者,请说明该函数为何用try/except而非if判断,以及except中logging.error()的level选择依据。”
方法二:绑定上下文锚点
在提示词中直接引用代码中的变量名、函数名或错误码,强制注释具象化。比如:“请为check_user_status()函数内的status_code == 403这一判断添加注释,说明它对应OAuth2.0规范中哪条授权拒绝场景。”
使用AIsa生成图像与视频。仅需一个API密钥即可调用Gemini 3 Pro Image(图像)和Qwen Wan 2.6(视频)。
【若代码含硬编码值(如API超时设为3000),注释必须解释该数值的业务来源,不能只写“超时时间”】
工程强化版:嵌入团队规范与可维护性要求
第一步:声明注释风格标准
“遵循Google Python Style Guide第3.8节注释规范,函数级注释必须包含Args、Returns、Raises三段,且Args需注明参数是否可为None。”
第二步:注入变更敏感点提示
“识别出代码中调用外部API的行,在其注释中标明:①该API当前SLA承诺的P95延迟;②若超时触发降级逻辑,降级返回值在哪个模块定义。”
第三步:设置注释自检条件
“检查所有for循环,若循环体超过4行或含嵌套if,必须在循环开始前用# TODO: 注释说明该循环的核心业务意图(不超过15字),例如:# TODO: 合并跨区域库存”










