加示例能显著提升注释质量，因其明确语义边界与风格标尺；需同语言、同场景、同复杂度的1–3个真实示例，配合角色声明、分隔标识、待注释代码及自检指令四步嵌入prompt。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
用ChatGPT生成脚本注释时，加不加示例直接影响注释是否贴合业务逻辑、术语是否统一、层级是否合理——不加示例常出现“功能描述泛泛而谈”“参数说明缺失类型约束”“边界条件完全忽略”三类硬伤。
为什么少样本提示比纯指令更可靠
模型对“详细注释”“清晰易懂”这类抽象词的理解存在巨大偏差。它可能把if x > 0:注释成“判断x是否大于零”，却漏掉“此处校验用户输入合法性，避免后续除零错误”这一关键上下文。提供1–3个真实带注释的同类代码片段，等于给模型划出明确的语义边界和风格标尺。
注意：示例必须与目标代码同语言、同调用场景、同复杂度。拿一个Flask路由函数的注释去引导生成Shell脚本的注释，模型会强行套用HTTP状态码、request对象等无关概念。
选哪个示例才真正起作用
方法一：选你项目里已有的高质量注释段
直接复制一段你团队公认写得好的函数注释（含docstring+行内注释+边界说明），粘贴在Prompt最前面。这能强制模型对齐现有工程规范，比如你们约定所有异常都写明触发条件，模型就不会再输出“可能出现错误”这种废话。
方法二：构造最小闭环示例
用目标脚本的同类结构手写一个极简但要素齐全的示例：含函数签名→docstring（Intent/Function/Boundary三行式）→2行核心逻辑→每行紧跟#注释→1个典型调用。这个示例不必可运行，但必须暴露全部注释维度。例如Shell脚本就写#!/bin/bash开头，Python就写def，不能混用。
【示例中必须包含参数类型、允许值范围、异常触发条件这三项，缺一不可】
ChatGPT Atlas（macOS）可在浏览网页时提供即时回复、内容总结与任务辅助。它支持智能建议、信息整理及多场景交互，同时配备可控隐私设置，让用户在使用过程中更加安全安心。针对 macOS 平台优化后，带来流畅自然的浏览体验，适用于办公、学习、创作及日常信息查询等多种场景。
怎么把示例嵌进Prompt不翻车
第一步：在Prompt开头固定声明角色与任务
“你是一位Linux运维脚本专家，正在为SRE团队编写生产级Bash工具。请严格按以下示例风格为待注释脚本添加中文注释。”
第二步：插入示例，用分隔线明确区隔
“———参考示例开始———
#!/bin/bash
# Intent: 安全清理临时目录，防止磁盘爆满导致服务中断
# Function: 扫描/var/tmp下超72小时且非root进程创建的文件，执行rm -f；返回成功删除数
# Boundary: 仅接受单个路径参数（默认/var/tmp），拒绝相对路径或通配符；若磁盘使用率＞90%，中止并echo警告
TEMP_DIR="${1:-/var/tmp}"
# 校验输入路径是否为绝对路径且存在 → 防止误删家目录
if [[ ! "$TEMP_DIR" =~ ^/ ]] || [[ ! -d "$TEMP_DIR" ]]; then echo "ERROR: 必须传入绝对路径"; exit 1; fi
———参考示例结束———”
第三步：紧接“待注释代码：”并粘贴目标脚本
第四步：末尾加校验指令（关键）
“输出前自检：① 是否每行可执行语句都有对应#注释；② docstring是否含Intent/Function/Boundary三要素；③ 所有参数校验逻辑是否被注释覆盖。未通过则重写。”
