項(xiàng)目編碼規(guī)范

1、項(xiàng)目開(kāi)發(fā)規(guī)則C#命名規(guī)范1.1命名空間框架中所有命名空間的起始部分業(yè)務(wù)中所有命名空間的起始部分實(shí)際結(jié)構(gòu)和名稱以業(yè)務(wù)為準(zhǔn)1.2類1)2)3)4)5)6)例：名字應(yīng)該能夠標(biāo)識(shí)事物的特性。名字可以有兩個(gè)或三個(gè)單詞組成，但通常不應(yīng)多于三個(gè)。 米用Pascal case ，所有單詞第一個(gè)字母大與。使用名詞或名詞短語(yǔ)命名類。少用縮寫(xiě)。不要使用下劃線字符 (_)。public class FileStreampublic class Butt on1.3 接口和類命名規(guī)范相同，唯一區(qū)別是接口在名字前加上“I”前綴例：in terface IDBComma ndin terface IButt on1.4枚舉

2、和類命名規(guī)范相同，唯一區(qū)別是枚舉在名字前加上“E”前綴例：enum ESystemType1.5方法1) 使用動(dòng)詞或動(dòng)詞短語(yǔ)命名方法。2) 采用Pascal case ，所有單詞第一個(gè)字母大寫(xiě)。3) 方法中的參數(shù)命名采用Camel cas in g,所有單詞第一個(gè)字母大寫(xiě)，除了首字母小寫(xiě)。1.6屬性1)使用名詞或名詞短語(yǔ)命名2) 采用Pascal case ，所有單詞第一個(gè)字母大寫(xiě)3)少用縮寫(xiě)4)不要使用下劃線字符(_ )1.7 變量1)變量名稱=變量的前綴+代表變量含意的英文單詞或單詞縮寫(xiě)。常用變量類型的前綴命名規(guī)則，定義如下:類型前綴2)public class Helloprivate

3、stri ng m_strName;public stri ng Namegetreturn m_strName;3) 即使對(duì)于可能僅岀現(xiàn)在幾個(gè)代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對(duì)于短循環(huán)索引使用單字母變量名，如 i或j。4) 不要使用原義數(shù)字或原義字符串，如for (int i = 1;i <= 7;i+)。而是使用命名常數(shù)，如for (int i = 1;i <=NUM_DAYS_IN_WE；EK+)以便于維護(hù)和理解。1.8 常量1)常量的名字應(yīng)該都大寫(xiě)，并且指岀完整含義，單詞之間用下劃線(例：const int PAGE_COUNT = 10;_)分隔。1.

4、9 控件前臺(tái)系統(tǒng)開(kāi)發(fā)時(shí)，只能使用下面列岀的控件，又不能滿足要求請(qǐng)先和模塊負(fù)責(zé)人聯(lián)系。討論通過(guò)后才可使用，規(guī)范修改前嚴(yán)禁使用未列岀的控件。Framework有提供相應(yīng)控件的，不得使用.Net標(biāo)準(zhǔn)控件控件命名 =Win dow控件縮寫(xiě)前綴+ 變量名1.10數(shù)據(jù)集命名規(guī)范控件類型命名ButtonBtnCheckBoxChkComboBoxCmbDateTimeBoxDtbGroupBoxGrbLabelLblLookupBoxLkpNumericBoxNumPanelPnlProgressBarPgbRadioButt onRadTextBoxTxtMemoEditMemoTreeViewTvwDa

5、taGridGridDataListListImageImgDropDow nListDrp1) 普通數(shù) 據(jù)集命名以Ds 開(kāi)頭2) 作為查 詢參數(shù) 的數(shù)據(jù) 集命名 以DsQuery開(kāi)頭，表 名以QUERY_為前綴3) 元素的所有字母大寫(xiě)，各字母以下劃線“ _”分割4) 專用名詞建議使用習(xí)慣縮寫(xiě)5) 與后臺(tái)交互的數(shù)據(jù)集不允許使用屬性1.11注釋注釋規(guī)范包括：類注釋規(guī)范、類的屬性、方法注釋規(guī)范、代碼間注釋規(guī)范1.11.1類注釋規(guī)范類開(kāi)始必須以以下形式書(shū)寫(xiě)類注釋：項(xiàng)目文件（*csproj） 簽岀后應(yīng)當(dāng)盡早簽入，以避免影響其他人使用。2. 簽入前必須先編譯通過(guò)，編譯通過(guò)后的文件允許簽入3. 相關(guān)文件必

6、須一次性簽入，推薦整個(gè)項(xiàng)目一次性整體簽入4 .每日下班前，必須簽入編譯通過(guò)的版本?？倓t：不管你用什么命名方法，所有的命名規(guī)則一定要統(tǒng)一，不要一會(huì)兒中文拼音一會(huì)兒英文等等。1、采用英文單詞或英文短語(yǔ)（包括縮寫(xiě)）作為名稱，不能使用無(wú)意義的字符或漢語(yǔ)拼音。2、每個(gè)數(shù)據(jù)庫(kù)對(duì)象表，視圖，字段，存儲(chǔ)過(guò)程，不要用任何數(shù)據(jù)庫(kù)的關(guān)鍵詞作為名稱。凡是能寫(xiě) 注釋的地方，應(yīng)該寫(xiě)上注釋，以便查看。3、名稱應(yīng)該清晰明了，能夠準(zhǔn)確表達(dá)事物的含義，最好可讀，遵循“見(jiàn)名知意”的原則。4、 對(duì)長(zhǎng)度也要有限制，最好不要超過(guò)30個(gè)字符，在PD設(shè)置生成時(shí)，部分?jǐn)?shù)據(jù)庫(kù)對(duì)象會(huì)自動(dòng)截取 到30位。5、 所有名稱的字符范圍為：A-Z, a-z

7、, 0-9和_（下劃線）。不允許使用其他字符作為名稱。6、注釋分單行和雙行，在數(shù)據(jù)庫(kù)對(duì)象如函數(shù)，存儲(chǔ)過(guò)程，視圖等，都需要在頁(yè)頭添加數(shù)據(jù) 庫(kù)對(duì) 象前綴命名說(shuō)明表寫(xiě)法一：模塊名具體功能實(shí)體名，如用戶角色表User_Role等，寫(xiě)法二：直接寫(xiě)成 UserRole，不用"”來(lái)區(qū)分，看習(xí)慣和所用數(shù)據(jù)庫(kù)。列名表名縮寫(xiě)_寫(xiě)法：表名縮寫(xiě)_具體內(nèi)容如用戶角色表 User_Role的名稱：UR_Name如果是單個(gè)的表名，比如區(qū)域表Area,則可以寫(xiě)成Area_ID。存儲(chǔ)過(guò)程sp_ up_ proc_單個(gè)表直接用表名，并加功能，大小與均可（Add,Edit,Del,Query,Report,Validat

8、e等）視圖vw_vw_直接的內(nèi)容，一般是用于查詢Query和報(bào)表Report兩種情形觸發(fā) 器trg_方法一：trg_表名_方法名之前之后等比如：trg_User_Info_lnsert方法二：觸發(fā)器分為行級(jí) Row【R】和語(yǔ)句級(jí)Statement【S】， 又分為after【A】，before【B】，in stead of 【I】， 方法又有二種Insert【I】,Update【Ul ,Detele【D】，所以：如:trg_User_Info_RBI（代表語(yǔ)句級(jí)，之前,插入操作），有點(diǎn)專業(yè)，不知道命名規(guī)則的人看不明白。函數(shù)fn_ f_fn_功能名稱。一些是具體的操作函數(shù)，比如字符串處理，fn_S

9、plitStr（參數(shù)）處理字符串，如果與模塊相關(guān)，則fn_模塊名稱_具體方法主鍵pk_pk_表名或縮寫(xiě)_列名簡(jiǎn)潔的寫(xiě)法：與法一：pk_表名，?寫(xiě)法二：pk列名，因?yàn)榱忻O(shè)計(jì)時(shí)已經(jīng)包含表的含義外鍵fk_fk從表名字段主表名字段。這個(gè)推薦索引idx_idx_表名_字段名（一個(gè)或多個(gè)）【可以在其后加 U或者C,規(guī)則冋觸犯器】 推存使用：idx_字段名一是唯一 Unique【U】與非唯一 NonUnique【N】一是聚集Cluster【C】與非聚集Non Cluster【N】約束ck_1默認(rèn)約束：df_表名_列名，df_列名2.唯一約束：uni_表名_列名，uni_列名3.檢查約束：【ck列名】，【ck表名 列名】4.主鍵約束：【pk_表名】，【pk_列名】5.外鍵約束：fk_表名_REFERENC表名序列seq_與法1: seq_User_Info （因?yàn)槊總€(gè)表一般只有一個(gè)序列）寫(xiě)法2: seq_UI_ID（因?yàn)楸砻x已經(jīng)包含在字段中）寫(xiě)法3： seq_User_Info_UI_ID（表名加字段名）事務(wù)trans_trans_游標(biāo)crs