影刀RPA完全指南：RPA流程命名规范与注释标准完整手册
影刀RPA完全指南：RPA流程命名规范与注释标准完整手册
流程写完能跑不等于流程写得好。我在公司接手过别人写的影刀RPA流程，变量名叫a、b、c，没有任何注释，看了一小时都没搞懂逻辑。后来我花了一周整理出一套命名规范和注释标准，团队所有人按这套规范写，交接时间从一天缩到十分钟。
这篇是影刀RPA流程规范的完整手册，覆盖变量命名、流程命名、注释标准、文件管理四个维度。
变量命名规范与类型标识
影刀RPA的变量管理面板在编辑界面底部，所有变量在这里统一管理。变量名是流程可读性的第一道关。
好的变量名应该不看注释就能猜出含义，差的变量名三天后自己都忘了是什么。
变量命名规范对照
| 命名方式 | 示例 | 是否推荐 | 原因 |
|---|---|---|---|
| 前缀+驼峰 | str商品标题 | 推荐 | 类型+含义，一目了然 |
| 纯中文 | 商品标题 | 推荐 | 非技术人员友好，可读性好 |
| 单字母 | a,b,tmp | 禁止 | 完全无法理解含义 |
| 拼音缩写 | sptitle | 禁止 | 混合语言，容易拼错 |
| 英文驼峰 | goodsTitle | 可接受 | 适合有英文基础的团队 |
| 下划线 | goods_title | 可接受 | Python风格 |
操作步骤：
- 在影刀RPA底部"变量面板"中，每创建一个变量都按规范命名
- 类型前缀规则：
str=字符串、int=整数、lst=列表、dict=字典、bol=布尔 - 循环变量用
idx开头：idx当前页码、idx当前商品 - 临时变量用
tmp开头：tmp价格文本、tmp转换结果 - 全局配置变量用
cfg开头：cfg超时时间、cfg最大重试次数
# 影刀RPA中变量命名的实际应用对照# ❌ 差的命名a="蓝牙耳机"# 不知道a是什么b=29.9# 不知道b是什么c=[]# 不知道c存什么tmp=True# 临时变量太多分不清# ✅ 好的命名str商品标题="蓝牙耳机"# 字符串类型，商品标题flt商品价格=29.9# 浮点类型，商品价格lst商品列表=[]# 列表类型，商品列表[video(video-VqdEX7G8-1785092109375)(type-csdn)(url-https://live.csdn.net/v/embed/526818)(image-https://v-blog.csdnimg.cn/asset/582d14c3bd0451c5399cd990b56e2a0d/cover/Cover0.jpg)(title-拼多多店群自动化报活动上架！)]bol采集成功=True# 布尔类型，采集是否成功# ✅ 循环变量命名idx当前页码=1# 索引变量，当前页码idx当前商品=0# 索引变量，当前商品序号# ✅ 配置变量命名cfg超时时间=10# 配置变量，超时秒数cfg最大重试次数=3# 配置变量，最大重试次数cfg采集网址="https://..."# 配置变量，目标网址这里很容易踩坑，注意看：影刀RPA变量名支持中文，但Python代码中引用时需要用英文变量名。如果流程中混用影刀RPA指令和Python代码，建议统一用英文驼峰命名。
流程与子流程命名规则
影刀RPA的流程名和子流程名是流程架构的目录，命名混乱会让整个项目难以维护。
子流程命名规范
| 前缀 | 含义 | 示例 |
|---|---|---|
主流程_ | 主流程入口 | 主流程_拼多多商品采集 |
子流程_ | 子流程模块 | 子流程_登录模块 |
工具_ | 工具类流程 | 工具_截图通知 |
公共_ | 多流程共用的公共流程 | 公共_Excel写入 |
测试_ | 测试用流程 | 测试_XPath验证 |
操作步骤：
- 在影刀RPA左侧"流程面板"中右键"新建流程"
- 流程名按
前缀_平台_功能格式命名 - 子流程的输入输出参数也要命名规范
- 参数名用
in_和out_前缀区分方向
# 影刀RPA项目流程结构示例 主流程_拼多多商品采集 ├── 子流程_拼多多_登录 ├── 子流程_拼多多_搜索关键词 ├── 子流程_拼多多_采集商品列表 ├── 子流程_拼多多_翻页处理 ├── 子流程_公共_写入Excel ├── 工具_截图通知  └── 公共_日志记录 # 子流程参数命名： # 子流程_拼多多_登录 # 输入参数: in_账号(String), in_密码(String), in_网址(String) # 输出参数: out_登录状态(Boolean), out_错误信息(String)影刀RPA的流程参数输入输出在子流程编辑界面的右侧面板配置。每个参数要设置名称、类型和默认值。参数名带上方向前缀（in_/out_），调用时一眼就知道是输入还是输出。
注释标准与关键节点标注
影刀RPA没有代码注释，但有两种注释方式：指令备注和"输出日志"指令做分段标记。
注释不是写给自己看的，是写给三个月后接手的人看的。
操作步骤：
每条关键指令在指令详情面板的"备注"栏写一句话说明
每个功能模块开头拖入"输出日志"指令，内容为
"===== 模块名 ====="复杂逻辑处加"输出日志"指令解释下一步意图
异常处理Catch块中必须写清楚可能的错误原因
注释标准对照
| 指令类型 | 是否需要备注 | 备注示例 |
|---|---|---|
| 打开网页 | 需要 | “打开拼多多商家后台” |
| 输入文本 | 需要 | “输入搜索关键词，来自cfg关键词变量” |
| 循环指令 | 需要 | “遍历商品列表，逐条提取数据” |
| 条件判断 | 需要 | “判断是否有下一页，没有则跳出循环” |
| 等待指令 | 需要 | “等待商品列表加载完成，超时10秒” |
| 设置变量 | 视情况 | “行号+1，准备写入下一行” |
| 输出日志 | 不需要 | 日志本身就是说明 |
# 影刀RPA中用"输出日志"指令做流程分段注释# 模块开始标记"===== 模块开始: 登录模块 =====""打开拼多多商家后台: https://mms.pinduoduo.com""输入账号密码（账号来自cfg变量）""点击登录按钮，等待首页加载""验证登录: 检查是否出现'欢迎'字样"# 关键决策点注释"判断登录是否成功: True=继续采集, False=发通知退出"# 模块结束标记"===== 模块结束: 登录模块 | 状态: 成功 | 耗时: 15秒 ====="# 异常处理注释"Catch块: 登录失败的常见原因: 1.密码错误 2.验证码 3.账号被限制""Catch块: 处理方式: 截图+通知+重试3次"推荐一个方法，实测好用：每个模块的"输出日志"标记用统一的格式（===== 模块名 =====），这样在运行日志面板中搜索"====="就能快速定位到每个模块的执行位置。
文件目录管理与版本控制
影刀RPA流程文件本身在客户端管理，但采集结果文件、日志文件、配置文件需要规范的目录结构。
推荐目录结构
C:/Desktop/RPA项目/ ├── 流程文件/ # 影刀RPA导出的.flow文件 │ ├── 拼多多商品采集.flow │ └── 淘宝评价抓取.flow ├── 配置文件/ # 账号、Cookie等配置 │ ├── 账号配置.xlsx │ └── Cookie记录.txt ├── 采集结果/ # 输出的数据文件 │ ├── 20250626/ # 按日期分目录 │ │ ├── 拼多多_商品数据.xlsx │ │ └── 淘宝_评价数据.xlsx [video(video-60w9YS3W-1785092115990)(type-csdn)(url-https://live.csdn.net/v/embed/526817)(image-https://v-blog.csdnimg.cn/asset/1d3c3709da119dd8c13ab01e9b282520/cover/Cover0.jpg)(title-TEMU店群矩阵自动化运营核价报活动)] ├── 日志/ # 运行日志 │ ├── 20250626/ │ │ ├── 拼多多采集.log │ │ └── 运行报告.txt ├── 截图/ # 异常截图 │ └── 20250626/ └── 通用模板/ # 复用的Excel模板 └── 商品数据模板.xlsx操作步骤：
- 在影刀RPA流程开头用"执行Python代码"指令创建当天目录
- 所有文件路径用变量统一管理，不要硬编码
- 采集结果文件名格式：
平台_数据类型_日期.xlsx
# 影刀RPA中文件路径管理importosfromdatetimeimportdatetimedefinit_file_paths(platform,data_type):"""初始化当天文件路径，自动创建目录"""today=datetime.now().strftime("%Y%m%d")base_dir="C:/Desktop/RPA项目"# 各类文件的目录路径paths={"结果目录":os.path.join(base_dir,"采集结果",today),"日志目录":os.path.join(base_dir,"日志",today),"截图目录":os.path.join(base_dir,"截图",today)}# 批量创建目录forpathinpaths.values():os.makedirs(path,exist_ok=True)# 生成具体文件路径result_file=os.path.join(paths["结果目录"],f"{platform}_{data_type}_{today}.xlsx")log_file=os.path.join(paths["日志目录"],f"{platform}_{today}.log")return{"结果文件":result_file,"日志文件":log_file,"截图目录":paths["截图目录"],"日期":today}# 影刀RPA中调用：# paths = init_file_paths("拼多多", "商品数据")# 后续所有指令引用 paths["结果文件"] 等变量影刀RPA社区版不支持流程导出和版本管理，创业版可以导出.flow文件做版本备份。建议每周导出一次流程文件，用日期命名备份：拼多多采集_20250626.flow。
常见问题速查
Q：变量名用中文还是英文？
A：纯影刀RPA指令流程推荐用中文变量名，非技术人员更容易理解。如果流程中大量使用"执行Python代码"指令，建议用英文变量名，因为Python代码中引用中文变量名需要特殊处理。Q：子流程应该拆到什么粒度？
A：一个子流程只做一件事。登录是一个子流程、采集是一个子流程、写入是一个子流程。如果子流程超过20条指令，说明可以继续拆。子流程嵌套不超过3层。Q：旧流程不规范怎么重构？
A：不要一次性重写，按模块逐步替换。先把变量名改成规范命名，再加注释，最后拆子流程。每改一个模块就测试一次，确保不影响现有功能。Q：团队多人协作怎么管理流程？
A：影刀RPA创业版支持团队协作，流程存在云端可多人查看。但同时编辑需要锁定。建议每人负责独立的流程模块，通过子流程调用组合。公共流程由一个人维护。
推荐资源
- 影刀RPA官方文档 - 子流程与流程管理章节
- 《代码整洁之道》Robert Martin著：虽然是讲编程的，但命名和注释理念通用
- 影刀RPA社区搜索"流程规范"，有团队分享的完整规范文档模板
#影刀RPA #RPA自动化 #流程规范 #日志系统 #多任务调度
作者：林焱
本文为《影刀RPA学习手册》系列文章之一，内容源于实操经验的整理与分享。