影刀RPA 流程文档与注释规范一个月后还能看懂自己的流程你有没有过这种经历——打开三个月前写的流程看了半小时没看懂自己写了什么变量叫a1、temp、x没有注释逻辑绕来绕去。代码是写给人看的顺带让机器执行。这篇文章给出一套轻量级的注释规范让你的流程三个月后还能维护。规范一流程文件的命名错误示范新建流程.flowtest.flow采集(1).flow最终版_真最终版_打死也不改了.flow正确命名{功能描述}_{版本号}.flow 好的命名 淘宝订单采集_v1.0.flow  ERP数据导入_v2.1.flow 每日报表生成_v1.0.flow命名规则用中文描述功能因为影刀用户主要是中文使用者加版本号改了哪些东西一眼就清楚不要用新建“测试”临时这些词——它们最终都会变成正式流程拼多多店群自动化报活动上架规范二变量命名错误示范a,b,c,x,temp,data,resultaaa,test1,asdf正确命名# 列表order_list# 订单列表clean_data_list# 清洗后的数据列表# 字典order_info# 单条订单信息config_dict# 配置字典# 字符串customer_name# 客户名target_url# 目标URL# 数字page_count# 页数retry_count# 重试次数# 布尔值is_login# 是否已登录has_error# 是否有错误# 全局变量加前缀g_db_host# 数据库地址g_api_token# API令牌命名原则看变量名就知道里面是什么。retry_count比x更能表达这是个计数值。规范三流程步骤的注释在影刀里没有注释这个组件但可以用【日志输出】做等效的事情。把日志输出既当调试工具又当注释在流程中 【日志输出】 第1步登录ERP系统 登录操作... 【日志输出】 第2步跳转到订单管理 页面跳转... 【日志输出】 第3步筛选待处理订单 筛选操作... 【日志输出】 第4步逐条处理订单 循环处理...跑流程的时候这些日志会出现在输出面板既是注释也是执行状态标记。规范四Python节点的注释在Python节点里写正常的注释# # 功能清洗从网页采集的订单数据# 输入raw_orders列表# 输出clean_orders列表、invalid_count数字# 作者林焱 | 日期2026-07-01# defclean_orders(raw_orders):清洗订单数据去空行、格式标准化、异常值标记clean[]fororderinraw_orders:# 跳过空行ifnotorder.get(订单号):continue# 金额格式化去掉千分位逗号和¥符号amount_strorder.get(金额,0)amount_stramount_str.replace(¥,).replace(,,)try:order[金额_数字]float(amount_str)except:order[金额_数字]0order[_异常]金额解析失败clean.append(order)returnclean规范五项目README在项目根目录放一个README.md记录项目的基本信息# 订单同步RPA项目 ## 项目说明 每天从淘宝/京东后台采集订单数据清洗后写入ERP系统。 ## 流程清单 - main.flow — 主流程调度 - subflows/01_collect_taobao.flow — 淘宝订单采集 - subflows/02_collect_jd.flow — 京东订单采集 - subflows/03_clean_data.flow — 数据清洗 - subflows/04_import_erp.flow — 写入ERP ## 定时任务 - 每天9:00自动执行影刀计划中心 ## 依赖 - Python库pandas, openpyxl, requests - 数据库MySQL 8.0 (192.168.1.100:3306) - ERP系统http://erp.internal.com ## 配置文件 - config/settings.json — 公共配置 - config/settings.prod.json — 正式环境配置 ## 维护记录 - 2026-07-01 v1.2 — 增加断点续跑 - 2026-06-15 v1.1 — 增加异常重试 - 2026-06-01 v1.0 — 初始版本 ## 注意事项 - 采集前确认电商后台没有弹窗活动页 - 大促期间数据量可能翻倍注意分批处理TEMU店群矩阵自动化运营核价报活动规范六复杂逻辑画流程图有些逻辑用文字很难说清——比如状态机的跳转规则、多层IF/ELSE嵌套。这种情况直接画图。在流程文件旁边放一张流程图截图或draw.io源文件比写200字注释直观得多。状态流转图.png 待付款 ──(超时)──→ 已取消 待付款 ──(付款)──→ 已付款 已付款 ──(推仓)──→ 已发货 已发货 ──(签收)──→ 已完成不需要注释的情况不是所有东西都需要注释。以下情况不需要注释# 给i加1 ← 废话注释i1# 不需要注释变量名已经够清楚了retry_count1page_number1好的变量名可以代替80%的注释。注释补充的是为什么这样做而不是重复在做什么。总结命名规范是给人看的、日志是给自己和接手的人留线索、README是给新人看的入门指南。花10%的时间写注释省下90%的维护时间。这买卖很划算。作者林焱
