上海某公司績效管理系統(tǒng)編程規(guī)范(存儲版)
【正文】 詞的第一個字母大寫，例如：BackColorb. Camel Casing 除了第一個單詞以外的每個單詞的第一個字母大寫，例如：backColor.c. Upper Casing如果縮寫字母的個數(shù)小于或等于2，那么所有的縮寫字母都大寫。所有注釋應(yīng)使用中文。在聲明前，原則上類的成員變量都要注釋。// 滿足支付條件if (MeetPayCondition()) …// 循環(huán)遍歷數(shù)組for ( int i = 0。如”Py”用來表示”拼音”會有很多的歧義。2， 單元測試代碼中用到的數(shù)字?！部梢詫懭氲姜毩⒌呐渲梦募?，在程序中讀出其中的數(shù)值。7. 關(guān)于值的判斷比較(1)布爾值布爾值的判斷比較不允許直接與false或者true進(jìn)行比較,更不能直接與0或者1進(jìn)行比較,例如if(bFlag==0) 或者if(bFlag==false)應(yīng)該遵循以下標(biāo)準(zhǔn)規(guī)則if(bFlag) 判斷變量為真if(!bFlag) 判斷變量為假(2)整形變量整形變量與0的比較應(yīng)采用== 或者!= 嚴(yán)禁整形變量與0比較時采用布爾值的比較方式.(3)浮點型的變量嚴(yán)禁浮點型變量用==或者!=進(jìn)行比較,=或者=進(jìn)行比較三． 通用規(guī)范1. 判斷與循環(huán)的注釋對于大段的（超過20行）判斷、循環(huán)語句，要加注釋，對于判斷語句（如if，switch），要說明判斷的條件和程序的走向。注意在其中運用xml語法。類的操作注釋由詳細(xì)設(shè)計產(chǎn)物導(dǎo)出，編程人員補(bǔ)充完成從Title到History的部分。2. 類的命名a. 用Pascal Casing 命名規(guī)則b. 謹(jǐn)慎的使用縮寫c. 不要使用任何的前綴（例如：C_GetList）d. 不要使用下劃線命名e. 已所擁有的功能作為描述命名3. 方法的命名a. 用Pascal Casing 命名規(guī)則b. 謹(jǐn)慎的使用縮寫c. 用動詞或動詞短語來命名（例如：public string GetAllList(){}）Data層的方法統(tǒng)一使用Insert()添加數(shù)據(jù)Update()修改數(shù)據(jù)GetModel()獲取一條數(shù)據(jù)GetModelList()獲取一個列表Delete()刪除數(shù)據(jù)d. 不要使用下劃線命名4. 屬性的命名a. 用Pascal Casing 命名規(guī)則b. 謹(jǐn)慎的使用縮寫c. 用名詞或名詞短語來命名d. 不要使用下劃線命名e. 可以考慮用類型名稱作為屬性名稱（例如： public Color Color{}）5. 接口的命名a. 用Pascal Casing 命名規(guī)則b. 謹(jǐn)慎的使用縮寫c. 接口的前綴命名統(tǒng)一用I（方法本身的描述中有I開頭的除外，例如：IGetPolicy）d. 不要使用下劃線命名e. 接口名字用名詞或者名詞短語，或形容詞來表述接口的行為6. 參數(shù)的命名a. 用Camel Casing 命名規(guī)則b. 謹(jǐn)慎的使用縮寫c. 由本地的參數(shù)類型+描述性單詞（例如：objCompanyList, strName, nCode）d. 不要使用保留參數(shù)（Win32 API）e. 參數(shù)的名字應(yīng)該是描述性的7. 變量的命名a. 用Camel Casing 命名規(guī)則b. 避免無意義的變量命名（如：string a = ()，但 for(int i=0。i5。例如：/// summary /// see cref=IUserM
公司管理相關(guān)推薦
鄂ICP備17016276號-1