Camstar開發C#代碼規範、Camstar更新以及Designer 開發規範

C#代碼規範

1.通用的兩種代碼規範：Camel(駝峯式)、Pascal(帕斯卡)

駝峯式：第一個單詞小寫，後面單詞首字母大寫其他小寫（例如：containerName）

帕斯卡：全部單詞首字母大寫其他都小寫（例如：Lotstart）

2.當且僅當私有成員能夠使用下劃線開始（例如：private string  _containerName）

3.參數名、成員變量、局部變量都統一使用駝峯式（例如：public void addSolit（string container Name）、string  arrayDemo）

4.類中的聲明、方法和屬性加上有效的Summery註釋

例如：

 

5.全部類名稱以及命名空間都使用帕斯卡規範（例如：namespace Camstar.Camstar Portal.App_Code.WebPortlets.Shopfloor、calss ResultCode）

6.本地變量以及參數名使用駝峯式規範

7.捕獲異常必須作異常處理

8.若是if語句塊的內容只有一行，能夠不加花括號，而且最好和if語句位於同一行

例如：if（index>0）return 1;

9.類型成員的排列順序自上而下依次爲：

字段：私有字段、受保護字段

屬性：私有屬性、受保護屬性、公有屬性

事件：私有事件、受保護事件、公有事件

構造函數：參數數量最多的構造函數，參數數量中等的構造函數，參數數量最少的構造函數

方法：重載方法的排列順序與構造函數相同，從參數數量最多往下至參數最少

10.若是方法返回的類型是bool類型，則其前綴爲Is，例如：IsHidden。

11.若是某個屬性的類型爲bool類型，則其前綴爲Can，例如：CanHidden。

12.集合類型命名：

數組：int[] startArray;  列表：List<Student> studentList;  表：DataTable/HashTable  

DataTable  startTable;

Camstar更新

1.MDB差別文件導出

（1）開發以前文件稱之爲BaseMDB，開發以後文件爲Modified MDB。

（2）MDB文件路徑：C:\Program Files (x86)\Camstar\InSite Administration

（3）打開Camstar Metadata Export選擇相應的BaseMDB和Modified MDB

 

（4）能夠選擇Select All，選擇全部差別。

 

（5）完成後可生成xml文件和html文件。

Designer 開發規範

（1）CDOS

新建對象及Filed不容許出現拼音，若是對象長度過長，能夠使用英文縮寫。

新建歷史記錄CDO，必須處於ServiceHistorySummary和ServiceHistoryDetail下。

 

新建Services CDO，須要創建在對應節點的套件節點之下。例如：

 

（2）CLFs

建立CLF必須創建UserFunctions節點下。

（3）Fields

Field Name必須以固定前綴開頭，不容許出現拼音，過長容許使用簡寫。

（4）Functions

建立客製化function必須創建在UserFunctions節點下且必須如下劃線開頭。

（5）Querys

建立客製化Query必須創建在AdvancedQuery節點下。

（6）Labels

建立客製化Label必須創建在OtherCompletion（成功）和OtherReject（失敗）節點下。

 

站在巨人的肩膀上真的會看的更遠更清晰！

　　　　　　　　　　　　　　　　　　　　　　　　　　　-----用志不分，乃凝於神