运维开发注释需聚焦执行逻辑、故障点与变更风险,应采用角色+任务+约束三要素构建提示词,并按“运维动作+触发条件+兜底行为”格式逐行添加注释,对rm -rf须注明路径来源和保留周期。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
运维开发写脚本时,注释要能快速让同事看懂执行逻辑、故障点和变更风险,不能只写“此处初始化变量”这种无效信息。用角色+任务+约束三要素构建提示词
第一步:明确告诉通义千问你当前的身份是“有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命令,注释中必须显式写出被删除路径的变量来源和保留周期”。


















