通义千问脚本注释提示词写法：运维开发实战指南

写运维脚本注释时，避免堆砌“初始化变量”这类空话，同行看完仍一头雾水。高质量注释必须直击核心：讲清代码执行链路、潜在风险点，以及修改时可能引发的连锁故障。

直接给出可落地的方案。构建注释提示词只需抓住三个维度：角色定位、任务描述、硬性约束。

用角色+任务+约束三要素构建提示词

第一步：向通义千问声明身份——你是一名具备5年Linux生产环境运维经验的Python脚本工程师。
第二步：明确任务——例如“为磁盘使用率检查与告警触发的Shell脚本生成注释”。
第三步：设定刚性约束——例如“每条注释必须标注【影响范围】与【跳过条件】，仅描述运维语义，不解释语法”。

将三要素合并为一条提示：“你是一名有5年Linux系统运维经验的Python脚本开发者，请为以下检查磁盘使用率并触发告警的Shell脚本生成注释，每段注释必须包含【影响范围】和【跳过条件】，不解释语法，只说明运维意图”。直接输入，避免迂回。

给关键函数加“运维上下文注释”的提示词写法

方法一：用“当……时，应……”句式锁定场景
输入提示词：“当脚本于凌晨2点执行自动巡检时，需要说明该函数是否允许跳过锁文件检测；请为check_disk_health()函数生成一行注释，格式为‘当……时，应……’”。

方法二：强制关联SOP依据
输入提示词：“依据《SRE-03磁盘告警响应SOP》，为send_alert_to_dingtalk()函数生成注释，注明调用前提条件以及失败后的人工介入路径”。【失败后不执行自动重试，必须由运维人员确认磁盘状态后手动触发】 —— 这条底线必须在注释中显式标出。

批量处理脚本注释的提示词模板

将原始脚本粘贴进对话框后，执行该指令：“逐行扫描以下脚本，对所有if/for/while块起始行、函数定义行、curl/wget调用行、rm/mv操作行分别添加一行注释，格式统一为‘【运维动作】+【触发条件】+【兜底行为】’”。

操作流程：直接把脚本内容粘贴到对话框，再发送上述指令即可。

注意：若脚本中出现rm -rf命令，请在提示词末尾追加“对所有rm -rf命令，注释中必须显式标注被删除路径的变量来源与保留周期”。此步不可省略，路径来源与保留周期必须写清楚，这是运维脚本的底线要求。