設(shè)計(jì)文檔介紹及討論

1、設(shè)計(jì)文檔介紹及討論設(shè)計(jì)文檔介紹及討論模板的版本號(hào)：模板的版本號(hào)：1.1.1 編號(hào)：編號(hào)：RZ-RC-OT-18-2修訂履歷修訂履歷修訂日期 修訂原因 修訂內(nèi)容 修訂人 版本號(hào) 計(jì)劃工時(shí)*消耗工時(shí)* 說(shuō)明：“計(jì)劃工時(shí)”指估算編寫(xiě)本教材的工時(shí)；“消耗工時(shí)”指實(shí)際消耗工時(shí)。日程介紹日程介紹 代碼文件編碼規(guī)范代碼文件編碼規(guī)范 數(shù)據(jù)庫(kù)編碼規(guī)范數(shù)據(jù)庫(kù)編碼規(guī)范 業(yè)務(wù)邏輯概要設(shè)計(jì)業(yè)務(wù)邏輯概要設(shè)計(jì) 頁(yè)面邏輯概要設(shè)計(jì)頁(yè)面邏輯概要設(shè)計(jì)3代碼文件編碼規(guī)范代碼文件編碼規(guī)范 Pascal和和Camel命名法命名法 代碼文件格式代碼文件格式 注釋注釋 命名命名 內(nèi)容內(nèi)容45Pascal命名法和命名法和Camel命名法命名法

2、 兩種命名方式均被兩種命名方式均被.NET Framework類庫(kù)使用。類庫(kù)使用。 Pascal命名法命名法 由一系列單詞組成，每個(gè)單詞的首字母大寫(xiě)，其它字母由一系列單詞組成，每個(gè)單詞的首字母大寫(xiě)，其它字母小寫(xiě)，不要使用下劃線。例子：小寫(xiě)，不要使用下劃線。例子：WebForm、HttpRequest。 Camel命名法命名法 和和Pascal命名法類似，區(qū)別在于首字母小寫(xiě)。例子：命名法類似，區(qū)別在于首字母小寫(xiě)。例子：firstPage, lastPage。6代碼文件格式代碼文件格式 盡量不要使用太寬的行。不要超過(guò)盡量不要使用太寬的行。不要超過(guò)160個(gè)西方字個(gè)西方字符（每個(gè)漢字相當(dāng)于符（每個(gè)漢字

3、相當(dāng)于2個(gè)西方字符）個(gè)西方字符） 正確地折行，折行以后需要正確地縮進(jìn)。正確地折行，折行以后需要正確地縮進(jìn)。 規(guī)范使用空格、括號(hào)、花括號(hào)。規(guī)范使用空格、括號(hào)、花括號(hào)。 Visual Studio 可以根據(jù)預(yù)定義的模板自動(dòng)進(jìn)行可以根據(jù)預(yù)定義的模板自動(dòng)進(jìn)行格式化。需要使用公司提供的格式化模板格式化。需要使用公司提供的格式化模板7注釋注釋避免使用過(guò)于花哨和裝飾性的注釋。避免使用過(guò)于花哨和裝飾性的注釋。注釋必須有意義，注釋用于幫助代碼的閱讀者理解代注釋必須有意義，注釋用于幫助代碼的閱讀者理解代碼。碼。不要包含版本控制和修訂的信息。這些工作由版本控不要包含版本控制和修訂的信息。這些工作由版本控制系統(tǒng)完成更

4、加合適。制系統(tǒng)完成更加合適。不要包含完全無(wú)用的注釋。不要包含完全無(wú)用的注釋。不要包含錯(cuò)誤的注釋。不要包含錯(cuò)誤的注釋。在一個(gè)長(zhǎng)方法（在一個(gè)長(zhǎng)方法（50行以上）中使用注釋。行以上）中使用注釋。長(zhǎng)方法必然包含比較復(fù)雜的業(yè)務(wù)邏輯，所以必須加入長(zhǎng)方法必然包含比較復(fù)雜的業(yè)務(wù)邏輯，所以必須加入注釋。注釋。8注釋（續(xù)）注釋（續(xù)）對(duì)外的方法必須加入注釋對(duì)外的方法必須加入注釋對(duì)外的方法往往被其他人閱讀，所以必須加入注釋。對(duì)外的方法往往被其他人閱讀，所以必須加入注釋。對(duì)參數(shù)進(jìn)行注釋。對(duì)參數(shù)進(jìn)行注釋。參數(shù)名往往比較簡(jiǎn)短，通過(guò)參數(shù)名不一定可以直觀知參數(shù)名往往比較簡(jiǎn)短，通過(guò)參數(shù)名不一定可以直觀知道這個(gè)參數(shù)的含義。道這個(gè)參

5、數(shù)的含義。簡(jiǎn)要說(shuō)明每個(gè)參數(shù)的具體含義。更詳細(xì)的描述可以放簡(jiǎn)要說(shuō)明每個(gè)參數(shù)的具體含義。更詳細(xì)的描述可以放在文檔中。在文檔中。在復(fù)雜的控制語(yǔ)句周圍使用注釋。在復(fù)雜的控制語(yǔ)句周圍使用注釋?？刂普Z(yǔ)句表示業(yè)務(wù)邏輯，復(fù)雜的控制語(yǔ)句表示復(fù)雜的控制語(yǔ)句表示業(yè)務(wù)邏輯，復(fù)雜的控制語(yǔ)句表示復(fù)雜的業(yè)務(wù)邏輯。業(yè)務(wù)邏輯。9命名命名基本原則基本原則除了用于循環(huán)體的變量以及短生命周期變量之外，任除了用于循環(huán)體的變量以及短生命周期變量之外，任何變量命名都應(yīng)當(dāng)有富有意義。比如何變量命名都應(yīng)當(dāng)有富有意義。比如int maxValue 的的意義比意義比 int x 更利于閱讀和理解。更利于閱讀和理解。循環(huán)體變量應(yīng)當(dāng)選擇循環(huán)體變量應(yīng)當(dāng)

6、選擇i,j,k,l,m,n等等。等等。循環(huán)體變量具有大家默認(rèn)的含義，所以不必太長(zhǎng)。循環(huán)體變量具有大家默認(rèn)的含義，所以不必太長(zhǎng)。循環(huán)體變量會(huì)被多次引用，所以不必太長(zhǎng)。循環(huán)體變量會(huì)被多次引用，所以不必太長(zhǎng)。短生命周期變量可以采用簡(jiǎn)寫(xiě)，比如短生命周期變量可以采用簡(jiǎn)寫(xiě)，比如int idx。短生命周期變量指：定義之后就被使用，并且很快就不再使用短生命周期變量指：定義之后就被使用，并且很快就不再使用的。的。10命名（續(xù)）命名（續(xù)）基本原則基本原則類和方法的命名都應(yīng)當(dāng)清晰且富有意義。類和方法的命名都應(yīng)當(dāng)清晰且富有意義。同一個(gè)概念前后命名要統(tǒng)一同一個(gè)概念前后命名要統(tǒng)一名詞、動(dòng)詞前后盡量一致。不要混合使用名詞、

7、動(dòng)詞前后盡量一致。不要混合使用Person、People或者或者StartDate、BeginDate或者或者Add、Insert。全部使用縮寫(xiě)，或者全部不用縮寫(xiě)。全部用全部使用縮寫(xiě)，或者全部不用縮寫(xiě)。全部用indexId或者全部用或者全部用idxId。對(duì)外的方法，參數(shù)順序也應(yīng)當(dāng)盡量一致。對(duì)外的方法，參數(shù)順序也應(yīng)當(dāng)盡量一致。同一個(gè)邏輯含義的方法，應(yīng)當(dāng)盡量同名，通過(guò)重載參數(shù)列表來(lái)區(qū)分。同一個(gè)邏輯含義的方法，應(yīng)當(dāng)盡量同名，通過(guò)重載參數(shù)列表來(lái)區(qū)分。任何時(shí)候都不應(yīng)當(dāng)采用中文命名。任何時(shí)候都不應(yīng)當(dāng)采用中文命名。拼音縮寫(xiě)命名應(yīng)當(dāng)盡量少采用拼音縮寫(xiě)命名應(yīng)當(dāng)盡量少采用。 混合使用英文和拼音會(huì)導(dǎo)致閱讀困難。混合

8、使用英文和拼音會(huì)導(dǎo)致閱讀困難。拼音本身很難做到見(jiàn)名知義。拼音本身很難做到見(jiàn)名知義。11命名（續(xù)）命名（續(xù)）名字空間名字空間使用使用Pascal命名法或者縮寫(xiě)。命名法或者縮寫(xiě)。例子：例子：System.Web.Utils、System.IO常量常量全部大寫(xiě)，全部大寫(xiě)， 多個(gè)單詞之間用下劃線連接。例子：多個(gè)單詞之間用下劃線連接。例子：MIN_DATE，MAX_DATE。變量和參數(shù)變量和參數(shù)局部變量采用局部變量采用Camel命名法。盡量采用形容詞命名法。盡量采用形容詞+名詞的方式名詞的方式。例子：。例子：totalPrice, hiddenText。因?yàn)樽兞客硎局髡Z(yǔ)。因?yàn)樽兞客硎局髡Z(yǔ)或者賓語(yǔ)

9、。例如：或者賓語(yǔ)。例如：user.Upload(report);成員變量采用成員變量采用“m_”前綴。前綴。不要使用類型前綴。不要使用類型前綴。只讀變量同常量。只讀變量同常量。12命名（續(xù)）命名（續(xù)）接口接口接口采用接口采用Pascal命名法，要求盡可能采用形容詞，并且應(yīng)當(dāng)命名法，要求盡可能采用形容詞，并且應(yīng)當(dāng)加入加入“I”前綴。比如前綴。比如IThrowable。接口的含義是能夠?qū)崿F(xiàn)某些功能，比如接口的含義是能夠?qū)崿F(xiàn)某些功能，比如IDisposable表示可以被釋放，表示可以被釋放，IClonable表示可以復(fù)制。表示可以復(fù)制。類類類采用類采用Pascal命名法，要求盡可能采用形容詞命名法，

10、要求盡可能采用形容詞+名詞的方式名詞的方式。比如。比如FastCache。如果某個(gè)類繼承自其它類，則盡可能采用修飾詞如果某個(gè)類繼承自其它類，則盡可能采用修飾詞+父類名的父類名的方式，比如方式，比如XmlConfigurator 繼承自繼承自 父類父類 Configurator。對(duì)于集合類型，應(yīng)當(dāng)采用基類型對(duì)于集合類型，應(yīng)當(dāng)采用基類型+“Collection”后綴。后綴。對(duì)于特性類型，即繼承自對(duì)于特性類型，即繼承自System.Attribute的類型，應(yīng)當(dāng)采的類型，應(yīng)當(dāng)采用用“Attribute”后綴。后綴。類的屬性也采用類的屬性也采用Pascal命名法，如果該屬性表示復(fù)數(shù)，則命命名法，如果該

11、屬性表示復(fù)數(shù)，則命名也應(yīng)當(dāng)采用復(fù)數(shù)形式。比如名也應(yīng)當(dāng)采用復(fù)數(shù)形式。比如Company.Employees。13命名（續(xù)）命名（續(xù)）方法方法方法采用方法采用Pascal命名法，要求盡可能采用動(dòng)詞命名法，要求盡可能采用動(dòng)詞+名詞的方式名詞的方式。比如。比如LoadBookById。方法往往作為謂語(yǔ)，表示某個(gè)動(dòng)作。方法往往作為謂語(yǔ)，表示某個(gè)動(dòng)作。對(duì)于表示是否的方法，采用對(duì)于表示是否的方法，采用“Is”前綴。例如：前綴。例如：IsFloatReport();對(duì)于表示存在的方法，采用對(duì)于表示存在的方法，采用“Exists”前綴。例如前綴。例如ExistsUser。對(duì)于同等業(yè)務(wù)邏輯含義的方法，盡可能采用參

12、數(shù)列表重載的對(duì)于同等業(yè)務(wù)邏輯含義的方法，盡可能采用參數(shù)列表重載的方式，不要增加太多的方法方式，不要增加太多的方法 。枚舉枚舉枚舉的命名方式同類。除非有額外的要求，否則枚舉對(duì)應(yīng)的枚舉的命名方式同類。除非有額外的要求，否則枚舉對(duì)應(yīng)的數(shù)字應(yīng)當(dāng)從數(shù)字應(yīng)當(dāng)從1開(kāi)始遞增。開(kāi)始遞增。對(duì)于可以疊加的枚舉，應(yīng)當(dāng)加入對(duì)于可以疊加的枚舉，應(yīng)當(dāng)加入Flag特性。特性。14代碼代碼方法方法盡量使用不定參數(shù)。盡量使用不定參數(shù)。當(dāng)需要對(duì)一批對(duì)象進(jìn)行處理時(shí)，調(diào)用方式更加直觀、簡(jiǎn)單。當(dāng)需要對(duì)一批對(duì)象進(jìn)行處理時(shí)，調(diào)用方式更加直觀、簡(jiǎn)單。對(duì)參數(shù)進(jìn)行斷言檢查。對(duì)參數(shù)進(jìn)行斷言檢查。如果參數(shù)本身不合法，那么后續(xù)執(zhí)行結(jié)果必然錯(cuò)誤。如果參數(shù)

13、本身不合法，那么后續(xù)執(zhí)行結(jié)果必然錯(cuò)誤。檢查內(nèi)容應(yīng)當(dāng)是合法性，而不需要檢查合理性。參數(shù)不合法往檢查內(nèi)容應(yīng)當(dāng)是合法性，而不需要檢查合理性。參數(shù)不合法往往預(yù)示編碼錯(cuò)誤，而參數(shù)不合理則有可能是邏輯錯(cuò)誤。往預(yù)示編碼錯(cuò)誤，而參數(shù)不合理則有可能是邏輯錯(cuò)誤。對(duì)運(yùn)行結(jié)果進(jìn)行斷言檢查。對(duì)運(yùn)行結(jié)果進(jìn)行斷言檢查。如果運(yùn)行結(jié)果不合法，那么后續(xù)的其它調(diào)用必然錯(cuò)誤。如果運(yùn)行結(jié)果不合法，那么后續(xù)的其它調(diào)用必然錯(cuò)誤。15代碼（續(xù)）代碼（續(xù)）循環(huán)循環(huán)盡量盡量LINQ實(shí)現(xiàn)循環(huán)操作。實(shí)現(xiàn)循環(huán)操作。語(yǔ)義清晰，結(jié)構(gòu)簡(jiǎn)單。語(yǔ)義清晰，結(jié)構(gòu)簡(jiǎn)單。出現(xiàn)錯(cuò)誤的可能性最小。出現(xiàn)錯(cuò)誤的可能性最小。容易擴(kuò)展，泛用性強(qiáng)。容易擴(kuò)展，泛用性強(qiáng)。如果無(wú)法使用如

14、果無(wú)法使用LINQ，盡量使用，盡量使用foreach實(shí)現(xiàn)循環(huán)操作實(shí)現(xiàn)循環(huán)操作。foreach循環(huán)出現(xiàn)邊界錯(cuò)誤的可能性比循環(huán)出現(xiàn)邊界錯(cuò)誤的可能性比f(wàn)or更小。更小。16代碼（續(xù)）代碼（續(xù)）集合集合盡量使用泛型集合。盡量使用泛型集合。泛型集合省去泛型集合省去box/unbox操作，效率更高。操作，效率更高。泛型集合采用強(qiáng)類型參數(shù)，不易出錯(cuò)。泛型集合采用強(qiáng)類型參數(shù)，不易出錯(cuò)。容易擴(kuò)展，泛用性強(qiáng)。容易擴(kuò)展，泛用性強(qiáng)。數(shù)據(jù)庫(kù)編碼規(guī)范數(shù)據(jù)庫(kù)編碼規(guī)范 表表 存儲(chǔ)過(guò)程和自定義函數(shù)存儲(chǔ)過(guò)程和自定義函數(shù) 注釋注釋 命名命名1718表表 基本表基本表 適當(dāng)進(jìn)行橫切和縱切。適當(dāng)進(jìn)行橫切和縱切。 表越少越好。表越少越好

15、。 不要保留無(wú)效的表或者重復(fù)的表。不要保留無(wú)效的表或者重復(fù)的表。 表的列越少越好。表的列越少越好。 可以適當(dāng)?shù)姆殖鲎颖?。具體做法是可以適當(dāng)?shù)姆殖鲎颖?。具體做法是“列轉(zhuǎn)行列轉(zhuǎn)行”。這樣以增加表為。這樣以增加表為代價(jià)，使邏輯結(jié)構(gòu)更加清晰，更容易編寫(xiě)代價(jià)，使邏輯結(jié)構(gòu)更加清晰，更容易編寫(xiě)SQL命令。命令。 代碼表代碼表 分為分為ID列，列，Seq列，列，Value列。列。 可以增加更多的列，比如可以增加更多的列，比如Category，表示代碼分類；，表示代碼分類；ParentId，表示上一級(jí)代碼等等。表示上一級(jí)代碼等等。19表（續(xù)）表（續(xù)） 索引索引 根據(jù)查詢來(lái)決定索引。根據(jù)查詢來(lái)決定索引。 可選值最

16、多的列需要建索引?？蛇x值最多的列需要建索引。 主鍵和外鍵主鍵和外鍵 任何表都必需有主鍵。主鍵全部使用任何表都必需有主鍵。主鍵全部使用GUID，即長(zhǎng)度為，即長(zhǎng)度為32的非的非Unicode文本。對(duì)于文本。對(duì)于SQLServer是是char(32)。 在數(shù)據(jù)合并、恢復(fù)或者事務(wù)中創(chuàng)建記錄的時(shí)候，自增在數(shù)據(jù)合并、恢復(fù)或者事務(wù)中創(chuàng)建記錄的時(shí)候，自增ID會(huì)帶來(lái)很會(huì)帶來(lái)很大麻煩。大麻煩。 盡可能定義外鍵。盡可能定義外鍵。 外鍵和主鍵共同構(gòu)成了各個(gè)實(shí)體之間的關(guān)系。外鍵和主鍵共同構(gòu)成了各個(gè)實(shí)體之間的關(guān)系。 盡量定義唯一性約束。盡量定義唯一性約束。20存儲(chǔ)過(guò)程和自定義函數(shù)存儲(chǔ)過(guò)程和自定義函數(shù) 存儲(chǔ)過(guò)程和自定義函數(shù)

17、應(yīng)當(dāng)盡可能少包含業(yè)務(wù)邏存儲(chǔ)過(guò)程和自定義函數(shù)應(yīng)當(dāng)盡可能少包含業(yè)務(wù)邏輯，除非該業(yè)務(wù)邏輯采用了批量操作。輯，除非該業(yè)務(wù)邏輯采用了批量操作。 數(shù)據(jù)庫(kù)擅長(zhǎng)進(jìn)行批量操作并且只擅長(zhǎng)進(jìn)行批量操作。數(shù)據(jù)庫(kù)擅長(zhǎng)進(jìn)行批量操作并且只擅長(zhǎng)進(jìn)行批量操作。 存儲(chǔ)過(guò)程和自定義函數(shù)應(yīng)當(dāng)盡可能少包含控制語(yǔ)存儲(chǔ)過(guò)程和自定義函數(shù)應(yīng)當(dāng)盡可能少包含控制語(yǔ)句，分支判斷和循環(huán)應(yīng)當(dāng)盡可能放在前臺(tái)開(kāi)發(fā)語(yǔ)句，分支判斷和循環(huán)應(yīng)當(dāng)盡可能放在前臺(tái)開(kāi)發(fā)語(yǔ)言（比如言（比如C#或者或者Java）中實(shí)現(xiàn)。）中實(shí)現(xiàn)。 分支判斷意味著業(yè)務(wù)邏輯。把業(yè)務(wù)邏輯分散在代碼和數(shù)分支判斷意味著業(yè)務(wù)邏輯。把業(yè)務(wù)邏輯分散在代碼和數(shù)據(jù)庫(kù)中，會(huì)造成極難維護(hù)。據(jù)庫(kù)中，會(huì)造成極難維護(hù)。

18、數(shù)據(jù)庫(kù)永遠(yuǎn)不適合做循環(huán)操作。數(shù)據(jù)庫(kù)永遠(yuǎn)不適合做循環(huán)操作。 存儲(chǔ)過(guò)程和自定義函數(shù)的作用應(yīng)當(dāng)單一，不要使存儲(chǔ)過(guò)程和自定義函數(shù)的作用應(yīng)當(dāng)單一，不要使用一個(gè)存儲(chǔ)過(guò)程或者函數(shù)實(shí)現(xiàn)多種功能。用一個(gè)存儲(chǔ)過(guò)程或者函數(shù)實(shí)現(xiàn)多種功能。21存儲(chǔ)過(guò)程和自定義函數(shù)（續(xù)）存儲(chǔ)過(guò)程和自定義函數(shù)（續(xù)） 存儲(chǔ)過(guò)程和自定義函數(shù)中盡量少使用存儲(chǔ)過(guò)程和自定義函數(shù)中盡量少使用eval或者類或者類似的語(yǔ)句，這種語(yǔ)句會(huì)造成調(diào)試?yán)щy，并且數(shù)據(jù)似的語(yǔ)句，這種語(yǔ)句會(huì)造成調(diào)試?yán)щy，并且數(shù)據(jù)庫(kù)無(wú)法對(duì)這種語(yǔ)句進(jìn)行優(yōu)化和緩存。庫(kù)無(wú)法對(duì)這種語(yǔ)句進(jìn)行優(yōu)化和緩存。 盡量避免在存儲(chǔ)過(guò)程或者自定義函數(shù)中開(kāi)啟事務(wù)盡量避免在存儲(chǔ)過(guò)程或者自定義函數(shù)中開(kāi)啟事務(wù)。事務(wù)屬于

19、業(yè)務(wù)邏輯范疇，盡可能放在前臺(tái)開(kāi)發(fā)。事務(wù)屬于業(yè)務(wù)邏輯范疇，盡可能放在前臺(tái)開(kāi)發(fā)語(yǔ)言（比如語(yǔ)言（比如C#或者或者Java）中實(shí)現(xiàn)。）中實(shí)現(xiàn)。 不要在存儲(chǔ)過(guò)程或者自定義函數(shù)中檢查參數(shù)合法不要在存儲(chǔ)過(guò)程或者自定義函數(shù)中檢查參數(shù)合法性。都放在前臺(tái)開(kāi)發(fā)語(yǔ)言（比如性。都放在前臺(tái)開(kāi)發(fā)語(yǔ)言（比如C#或者或者Java）中實(shí)現(xiàn)。中實(shí)現(xiàn)。 不要在存儲(chǔ)過(guò)程或者自定義函數(shù)中使用游標(biāo)。不要在存儲(chǔ)過(guò)程或者自定義函數(shù)中使用游標(biāo)。 每次游標(biāo)移動(dòng)每次游標(biāo)移動(dòng) ，都意味著重新執(zhí)行一遍查詢，都意味著重新執(zhí)行一遍查詢SQL。22命名命名 變量和參數(shù)變量和參數(shù) 采用采用Camel命名法命名法, 要求盡可能采用名詞或者形容詞要求盡可能采用名詞

20、或者形容詞+名詞的方式。名詞的方式。 對(duì)參數(shù)進(jìn)行注釋。對(duì)參數(shù)進(jìn)行注釋。23命名（續(xù)）命名（續(xù)）表表 表采用表采用Pascal命名法，要求盡可能采用形容詞命名法，要求盡可能采用形容詞+名詞的方式名詞的方式。比如。比如“Report”。 對(duì)于代碼表，要求采用對(duì)于代碼表，要求采用“Code”后綴，比如后綴，比如“ReportTypeCode”。 表的列也全部采用表的列也全部采用Pascal命名法，要求盡可能采用形容詞命名法，要求盡可能采用形容詞+名詞的方式，比如名詞的方式，比如“AllAsset”。 對(duì)于主鍵，要求采用表名對(duì)于主鍵，要求采用表名 + “Id”的方式命名，比如的方式命名，比如“ReportId”。這種方式在寫(xiě)比較負(fù)責(zé)的連接查詢時(shí)不易出錯(cuò)。這種方式在寫(xiě)比較負(fù)責(zé)的連接查詢時(shí)不易出錯(cuò)。 對(duì)于外鍵，要求和外鍵表的主鍵名完