代碼風(fēng)格沒有正確與否,重要的是整齊劃一,這是我擬的一份《項(xiàng)目代碼風(fēng)格要求》,供大家參考。什么是好的注釋:你寫的代碼別人能夠很容易的看懂, 這才是好的注釋, 命名規(guī)范, 代碼設(shè)計(jì)良好。 這才是好的注釋
良好代碼習(xí)慣的好處:
1.方便代碼的交流和維護(hù)。
2.不影響編碼的效率,不與大眾習(xí)慣沖突。
3.使代碼更美觀、閱讀更方便。
4.使代碼的邏輯更清晰、更易于理解。
在C#中通常使用的兩種編碼方式如下
Camel(駝峰式): 大小寫形式-除了第一個單詞,所有單詞第一個字母大寫,其他字母小寫。
Pascal(帕斯卡): 大小寫形式-所有單詞第一個字母大寫,其他字母小寫。
項(xiàng)目代碼風(fēng)格要求:
1 C# 代碼風(fēng)格要求 11 注釋
12 類型(類、結(jié)構(gòu)、委托、接口)、字段、屬性、方法、事件的命
13 不使用縮寫
14 代碼使用半展開
15 使用Tab作為縮進(jìn),并設(shè)置縮進(jìn)大小為4
16 一個cs源文件至多定義兩個類型
17 類型名稱和源文件名稱必須一致
18 所有命名空間、類型名稱使用Pascal風(fēng)格(單詞首字母大寫)
19 本地變量、方法參數(shù)名稱使用Camel風(fēng)格(首字母小寫,其后
110 私有方法、受保護(hù)方法,仍使用Pascal風(fēng)格命名
111 如果if語句內(nèi)容只有一行,可以不加花括號,但是必須和if
112 調(diào)用類型內(nèi)部其他成員,需加this;調(diào)用父類成員,需加base
113 類型內(nèi)部的私有和受保護(hù)字段,使用Camel風(fēng)格命名,但加“
114 不能出現(xiàn)公有字段
115 類型成員的排列順序
116 委托和事件的命名
117 返回bool類型的方法、屬性的命名
118 常見集合類型后綴命名
119 常見后綴命名
120 常見類型命名
121 常見字段、屬性命名
2 XHTML 代碼風(fēng)格要求
21 如果XHTML標(biāo)記有層次,那么代碼也要有層次
22 所有標(biāo)記必須閉合
23 如果標(biāo)記中間代碼超過20行,則應(yīng)在標(biāo)記末尾加注標(biāo)識
3 CSS 代碼風(fēng)格要求
31 代碼使用半展開
32 使用Tab作為縮進(jìn),并設(shè)置縮進(jìn)大小為4
33 代碼注釋
34 代碼編寫
35 嵌入式樣式的比例不超過樣式表代碼總量的10%
36 內(nèi)聯(lián)式樣式的比例不超過樣式表代碼總量的30%
37 外聯(lián)式樣式表的比例不少于樣式表代碼總量的60%
4 JavaScript 代碼風(fēng)格要求
41 代碼使用半展開
42 使用Tab作為縮進(jìn),并設(shè)置縮進(jìn)大小為4
43 代碼注釋
44 不得出現(xiàn)內(nèi)嵌式代碼
45 內(nèi)聯(lián)式代碼占JavaScript的總量不得超過40%
46 外聯(lián)式代碼占JavaScript的總量至少為60%