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(失敗)節點下。
站在巨人的肩膀上真的會看的更遠更清晰!
-----用志不分,乃凝於神