1. 命名規(guī)范

1.1 概述

描述了了關(guān)于RPA開發(fā)過程中的各種文件、參數(shù)的命名規(guī)范。

1.2 文件夾及文件

需要注意的是，如果客戶明確指定了文件的命名規(guī)則，請(qǐng)首先參考客戶給定的規(guī)則來進(jìn)行命名。

1.2.1 流程外層文件夾的命名規(guī)范應(yīng)當(dāng)為一個(gè)業(yè)務(wù)流程建立一個(gè)流程文件夾和組件文件夾，命名為業(yè)務(wù)流程的中文名稱或已知的英文名稱（如：云賬單樣張核對(duì)流程、數(shù)據(jù)監(jiān)測(cè)流程等）；?

1.2.2 項(xiàng)目文件夾的命名規(guī)范名稱應(yīng)當(dāng)以項(xiàng)目英文簡(jiǎn)寫若遇空格以【_】代替，或帕斯卡命名法：

1.2.3 流程xaml文件的命名規(guī)范名稱應(yīng)當(dāng)以實(shí)現(xiàn)功能英文簡(jiǎn)寫若遇空格以【_】代替，或帕斯卡命名法：通?？梢允褂茫骸緦?shí)現(xiàn)功能英文簡(jiǎn)寫】_【xaml】 組成;若有調(diào)用其他子流程，可以建立Main.xaml，在Main.xaml調(diào)用子流程文件命名的長(zhǎng)度應(yīng)當(dāng)遵循精煉原則，不超過100個(gè)字符

1.2.4 過程中產(chǎn)生的文件及文件夾的命名規(guī)范流程過程中可能產(chǎn)生一些過程文件或是輸出文件。對(duì)于此類文件，如果是客戶明確提出了名稱要求的，需遵循客戶提供的命名規(guī)則進(jìn)行；若沒有明確的命名規(guī)則，則可參考以下規(guī)則：? 中文文字/英文字母/下劃線【_】組成? 通常可使用:【流程名稱】_【文件用途/文件名稱】_[生成日期/月份].擴(kuò)展名

1、 發(fā)票對(duì)賬流程_發(fā)票處理記錄表_202001.xlsx

2、 報(bào)表下載流程_管理報(bào)表模板.xlsx

1.2.5 流程配置相關(guān)文件存儲(chǔ)路徑：流程配置相關(guān)的文件，若客戶有明確提出所需存儲(chǔ)的路徑和名稱（比如放在共享文件盤的指定文件夾中），則應(yīng)遵循客戶要求；否則，則建議將配置文件存儲(chǔ)在項(xiàng)目文件Data的目錄下，比如“C:\UiPath\xxx公司RPA項(xiàng)目_財(cái)務(wù)部_發(fā)票驗(yàn)證流程\InvoiceVerification\Data”。文件命名：如果是特定流程專用的配置文件，則建議在文件命名時(shí)標(biāo)明。如“C:\UiPath\xxx公司RPA項(xiàng)目_財(cái)務(wù)部_發(fā)票驗(yàn)證流程\InvoiceVerification\Data\DailyReportProcessDepositType_ Config.XLSX”如果是多個(gè)流程使用的配置文件，則不要在文件名字體現(xiàn)流程名稱，請(qǐng)以Config命名如：“C:\UiPath\xxx公司RPA項(xiàng)目_財(cái)務(wù)部_發(fā)票驗(yàn)證流程\InvoiceVerification\Data\ Config.XLSX”。

1.3 Sequence及Activities Display Name命名規(guī)范名稱當(dāng)以中文為主，著重突出當(dāng)前Sequence實(shí)現(xiàn)的功能，若使用英文避免出現(xiàn)語(yǔ)法錯(cuò)誤

1.4 變量命名規(guī)范名稱應(yīng)當(dāng)以英文字母、數(shù)字和下劃線（_）組成，[_]表示聲明變量的基本類型以此增強(qiáng)可讀性；名稱應(yīng)當(dāng)以英文字母開頭，每個(gè)單詞的首字母大寫，其后字母小寫；下劃線后的如果是英文單詞，單詞首字母小寫；如果是多個(gè)單詞，后續(xù)單詞的首字母大寫；單詞縮寫應(yīng)當(dāng)全部大寫；流程變量的命名長(zhǎng)度建議不超過50個(gè)字符

選擇不同名稱的Scope，代表變量使用范圍不要申明名稱相同變量錯(cuò)誤示例： 此外，推薦使用英文作為開頭來命名變量，可以方便以后搜索過濾

基本類型的命名應(yīng)包含【參數(shù)描述】_【可選擴(kuò)展描述】_【類型縮寫】_，例如：? 字符串 XXX[_YYY]_ str? 數(shù)字 XXX[_YYY]_ int? 布爾 XXX[_YYY] bool? 其他類型同理可推

1、 name_str

2、 btnSearchImageExist_bool?

3、 productName_str

4、 serachElements_bool

1.5 其他類型（數(shù)組、對(duì)象）數(shù)組、對(duì)象在變量名稱中，應(yīng)當(dāng)至少標(biāo)識(shí)出最外層對(duì)象的類型：

數(shù)組 YYY[_ZZZ]_arr_XXX? 對(duì)象 YYY[_ZZZ]_obj_XXX

1、 ticketName_arr_str

2、 order_arr_obj

1.6 屏幕捕獲元素

所有屏幕捕獲元素，必須使用有意義的變量做為標(biāo)識(shí)：

模塊/窗口標(biāo)識(shí)_控件名稱[_可選擴(kuò)展標(biāo)識(shí)]_【控件類型】

按鈕： XXX[_YYY]_btn

輸入框：XXX[_YYY]_ipt

下拉框: XXX[_YYY]_sel

選擇框：XXX[_YYY]_chb

文字顯示：XXX[_YYY]_lbl

復(fù)選按鈕：XXX[_YYY]_chkb

單選按鈕：XXX[_YYY]_rdb

超鏈：XXX[_YYY]_ref

表格:XXX[_YYY]_tbl

列表XXX[_YYY]_lst

同理類推其他類型

1.7 備注

使用中文備注，可清晰知曉變量聲明含義及流程范圍代碼功能實(shí)現(xiàn)變量備注添加方式：1、 在Variable欄目，點(diǎn)擊聲明完成的變量，右鍵單擊，出現(xiàn)彈窗

2、 點(diǎn)擊Edit Annotation

3、 輸入備注信息并點(diǎn)擊ok即可

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

1、 選中Sequence或Activities，右鍵單擊，出現(xiàn)彈窗

2、 點(diǎn)擊Annotations,選擇Add Annotations

3、 輸入備注信息即可

1.8 名稱變更已在開發(fā)中的流程需要修改文件名稱或變量名稱時(shí)，需要注意名稱變更可能造成的影響，并對(duì)影響一一進(jìn)行處理。PS：鑒于以下影響，強(qiáng)烈建議在流程設(shè)計(jì)時(shí)，盡量避免使用常量來指定文件名稱及路徑，而最好采用配置化參數(shù)的方式來進(jìn)行設(shè)計(jì)，將文件名稱、路徑等參數(shù)放在外部配置表中進(jìn)行讀取，從而使得其發(fā)生更改時(shí)，只需要手動(dòng)修改配置表中的參數(shù)而無需修改流程中的邏輯節(jié)點(diǎn)。

1.8.1 流程文件夾的名稱變更流程文件夾的名稱若發(fā)生變更，需要檢查流程中與文件存取、寫入相關(guān)的步驟是否收到影響；如果流程中對(duì)于文件的操作使用了常量來指定絕對(duì)路徑，則可能導(dǎo)致流程處理發(fā)生問題。

1.8.2 xaml流程文件的名稱變更若xaml流程文件的名稱發(fā)生改變，需要檢查該xaml文件是否被其他流程引用；若有引用，則需要手動(dòng)對(duì)相關(guān)流程中的引用模塊重新定義路徑參數(shù)的值，并修改傳遞的參數(shù)。