RPA命名规范

1. 命名规范

1.1 概述

描述了了关于RPA开发过程中的各种文件、参数的命名规范。

1.2 文件夹及文件

需要注意的是，如果客户明确指定了文件的命名规则，请首先参考客户给定的规则来进行命名。

1.2.1 流程外层文件夹的命名规范应当为一个业务流程建立一个流程文件夹和组件文件夹，命名为业务流程的中文名称或已知的英文名称（如：云账单样张核对流程、数据监测流程等）； 

1.2.2 项目文件夹的命名规范名称应当以项目英文简写若遇空格以【_】代替，或帕斯卡命名法：

1.2.3 流程xaml文件的命名规范名称应当以实现功能英文简写若遇空格以【_】代替，或帕斯卡命名法：通常可以使用：【实现功能英文简写】_【xaml】 组成;若有调用其他子流程，可以建立Main.xaml，在Main.xaml调用子流程文件命名的长度应当遵循精炼原则，不超过100个字符

1.2.4 过程中产生的文件及文件夹的命名规范流程过程中可能产生一些过程文件或是输出文件。对于此类文件，如果是客户明确提出了名称要求的，需遵循客户提供的命名规则进行；若没有明确的命名规则，则可参考以下规则： 中文文字/英文字母/下划线【_】组成 通常可使用:【流程名称】_【文件用途/文件名称】_[生成日期/月份].扩展名

1、 发票对账流程_发票处理记录表_202001.xlsx

2、 报表下载流程_管理报表模板.xlsx

1.2.5 流程配置相关文件存储路径：流程配置相关的文件，若客户有明确提出所需存储的路径和名称（比如放在共享文件盘的指定文件夹中），则应遵循客户要求；否则，则建议将配置文件存储在项目文件Data的目录下，比如“C:\UiPath\xxx公司RPA项目_财务部_发票验证流程\InvoiceVerification\Data”。文件命名：如果是特定流程专用的配置文件，则建议在文件命名时标明。如“C:\UiPath\xxx公司RPA项目_财务部_发票验证流程\InvoiceVerification\Data\DailyReportProcessDepositType_ Config.XLSX”如果是多个流程使用的配置文件，则不要在文件名字体现流程名称，请以Config命名如：“C:\UiPath\xxx公司RPA项目_财务部_发票验证流程\InvoiceVerification\Data\ Config.XLSX”。

1.3 Sequence及Activities Display Name命名规范名称当以中文为主，着重突出当前Sequence实现的功能，若使用英文避免出现语法错误

1.4 变量命名规范名称应当以英文字母、数字和下划线（_）组成，[_]表示声明变量的基本类型以此增强可读性；名称应当以英文字母开头，每个单词的首字母大写，其后字母小写；下划线后的如果是英文单词，单词首字母小写；如果是多个单词，后续单词的首字母大写；单词缩写应当全部大写；流程变量的命名长度建议不超过50个字符

选择不同名称的Scope，代表变量使用范围不要申明名称相同变量错误示例： 此外，推荐使用英文作为开头来命名变量，可以方便以后搜索过滤

基本类型的命名应包含【参数描述】_【可选扩展描述】_【类型缩写】_，例如： 字符串 XXX[_YYY]_ str 数字 XXX[_YYY]_ int 布尔 XXX[_YYY] bool 其他类型同理可推

1、 name_str

2、 btnSearchImageExist_bool 

3、 productName_str

4、 serachElements_bool

1.5 其他类型（数组、对象）数组、对象在变量名称中，应当至少标识出最外层对象的类型：

数组 YYY[_ZZZ]_arr_XXX 对象 YYY[_ZZZ]_obj_XXX

1、 ticketName_arr_str

2、 order_arr_obj

1.6 屏幕捕获元素

所有屏幕捕获元素，必须使用有意义的变量做为标识：

模块/窗口标识_控件名称[_可选扩展标识]_【控件类型】

按钮： XXX[_YYY]_btn

输入框：XXX[_YYY]_ipt

下拉框: XXX[_YYY]_sel

选择框：XXX[_YYY]_chb

文字显示：XXX[_YYY]_lbl

复选按钮：XXX[_YYY]_chkb

单选按钮：XXX[_YYY]_rdb

超链：XXX[_YYY]_ref

表格:XXX[_YYY]_tbl

列表XXX[_YYY]_lst

同理类推其他类型

1.7 备注

使用中文备注，可清晰知晓变量声明含义及流程范围代码功能实现变量备注添加方式：1、 在Variable栏目，点击声明完成的变量，右键单击，出现弹窗

2、 点击Edit Annotation

3、 输入备注信息并点击ok即可

在Sequence及Activities添加备注添加方式：

1、 选中Sequence或Activities，右键单击，出现弹窗

2、 点击Annotations,选择Add Annotations

3、 输入备注信息即可

1.8 名称变更已在开发中的流程需要修改文件名称或变量名称时，需要注意名称变更可能造成的影响，并对影响一一进行处理。PS：鉴于以下影响，强烈建议在流程设计时，尽量避免使用常量来指定文件名称及路径，而最好采用配置化参数的方式来进行设计，将文件名称、路径等参数放在外部配置表中进行读取，从而使得其发生更改时，只需要手动修改配置表中的参数而无需修改流程中的逻辑节点。

1.8.1 流程文件夹的名称变更流程文件夹的名称若发生变更，需要检查流程中与文件存取、写入相关的步骤是否收到影响；如果流程中对于文件的操作使用了常量来指定绝对路径，则可能导致流程处理发生问题。

1.8.2 xaml流程文件的名称变更若xaml流程文件的名称发生改变，需要检查该xaml文件是否被其他流程引用；若有引用，则需要手动对相关流程中的引用模块重新定义路径参数的值，并修改传递的参数。