模塊設(shè)計(jì)報(bào)告1

1、精品綜合學(xué)校網(wǎng)站模塊設(shè)計(jì)報(bào)告文件狀態(tài)：文件標(biāo)識(shí)：SD-MODULE 草稿當(dāng)前版本：1.0正式發(fā)布作者：梁文江正在修改完成日期：2010-12-16welcome精品目 錄0.文檔介紹30.1文檔目的30.2文檔范圍30.3讀者對(duì)象31.模塊命名規(guī)則42.模塊匯總52.1模塊匯總表52.2模塊關(guān)系圖73.子系統(tǒng)前臺(tái)的模塊設(shè)計(jì)84.子系統(tǒng)后臺(tái)的模塊設(shè)計(jì)9welcome精品0. 文檔介紹0.1文檔目的說(shuō)明學(xué)校網(wǎng)站的設(shè)計(jì)過(guò)程，各應(yīng)用模塊的主要接口與屬性、數(shù)據(jù)結(jié)構(gòu)和算法。0.2文檔范圍項(xiàng)目經(jīng)理指定若干名開(kāi)發(fā)人員從事模塊的設(shè)計(jì)（以下稱為模塊設(shè)計(jì)人員），模塊設(shè)計(jì)人員將在實(shí)現(xiàn)階段編寫(xiě)這些模塊的代碼0.3讀者對(duì)

2、象模塊設(shè)計(jì)人員，測(cè)評(píng)人員welcome精品1. 模塊命名規(guī)則（ 1 ）用 C# 規(guī)則來(lái)命名方法和類，類名和應(yīng)用類的模塊英文名稱一致。（ news,chatroom）（ 2. ）用C# 規(guī)則來(lái)命名局部變量和方法的參數(shù),因?yàn)楦髂K與數(shù)據(jù)庫(kù)有聯(lián)系，所以變量名稱和數(shù)據(jù)庫(kù)中表的字段名車(chē)讓你更一致。（ 3 ） .接口的名稱加前綴 I interface ICompare int compare(); （ 4 ） .局部變量的名稱要有意義.不要用x， y ， z等等 (除用于For循環(huán)變量中可使用i,j,k,l,m,n).（ 5 ）所有的成員變量聲明在類的頂端，用一個(gè)換行把它和方法分開(kāi).（ 6 ）采用默認(rèn)的

3、名字命名namespace，如：產(chǎn)品名、公司名.（ 7 ）建議局部變量在最接近使用它時(shí)再聲明.（ 8 ）使用某個(gè)控件的值時(shí)，盡量命名局部變量.（ 9 ）把引用的系統(tǒng)的namespace和自定義或第三方的用一個(gè)換行把它們分開(kāi).（ 10 ）文件名要能反應(yīng)類的內(nèi)容，最好是和類同名，一個(gè)文件中一個(gè)類或一組關(guān)連類.（ 11 ）目錄結(jié)構(gòu)中要反應(yīng)出namespace的層次 .（ 12 ）大括號(hào) "" 要新起一行（ 13 ）、避免容易被主觀解釋的難懂的名稱，如方面名AnalyzeThis()，或者屬性名xxK8 。這樣的名稱會(huì)導(dǎo)致多義性。welcome精品（ 14）、只要合適， 在變量名的

4、末尾或開(kāi)頭加計(jì)算限定符（ Avg 、Sum 、Min 、Max 、Index ）。（ 15）、布爾變量名應(yīng)該包含Is ，這意味著Yes/No 或 True/False 值，如 fileIsFound 。（ 16）、在命名狀態(tài)變量時(shí)，避免使用諸如Flag的術(shù)語(yǔ)。狀態(tài)變量不同于布爾變量的地方是它可以具有兩個(gè)以上的可能值。不是使用documentFlag，而是使用更具描述性的名稱，如 documentFormatType。 （此項(xiàng)只供參考）（ 17）、即使對(duì)于可能僅出現(xiàn)在幾個(gè)代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對(duì)于短循環(huán)索引使用單字母變量名，如i 或 j 。 可能的情況下，盡量不要使

5、用原義數(shù)字或原義字符串。（ 18 ）、可使用約定俗成的縮寫(xiě)使名稱長(zhǎng)度適中，（ 19 ）、在內(nèi)部范圍中避免使用與外部范圍中的名稱相同的名稱。如果訪問(wèn)了錯(cuò)誤的變量，則可能會(huì)產(chǎn)生錯(cuò)誤結(jié)果。若變量與同一名稱的關(guān)鍵字沖突，則必須在關(guān)鍵字前加適當(dāng) 的 類 型 庫(kù) 以 作 標(biāo) 識(shí) 。 例 如 ， 如 果 有 一 個(gè) 名 為Date的 變 量 ， 通 過(guò) 調(diào)用 System.DateTime.Date只可以使用內(nèi)部Date函數(shù)。如果以上未做規(guī)定，以vs 2005的 C# 命名規(guī)范為準(zhǔn)。2. 模塊匯總2.1模塊匯總表子系統(tǒng)A 網(wǎng)站前臺(tái)模塊名稱功能簡(jiǎn)述welcome精品用戶登錄給予用戶登錄網(wǎng)站客戶注冊(cè)客戶注冊(cè)成為

6、本站會(huì)員分類搜索客戶可以搜索相關(guān)產(chǎn)品聊天新用戶注冊(cè)后可以進(jìn)入聊天購(gòu)物車(chē)實(shí)時(shí)顯示用戶當(dāng)前所購(gòu)產(chǎn)品，可以增加或刪除訂單查詢客戶依此號(hào)碼可以查詢所購(gòu)產(chǎn)品數(shù)目與產(chǎn)品情況子系統(tǒng)B 網(wǎng)站后臺(tái)模塊名稱功能簡(jiǎn)述后臺(tái)用戶管理普通用戶的添加，刪除，修改后臺(tái)訂單管理實(shí)現(xiàn)對(duì)訂單的添加/ 刪除 / 修改管理。后臺(tái)產(chǎn)品信息管理實(shí)現(xiàn)分類管理、類別設(shè)置、廠家管理客戶權(quán)限管理管理人員實(shí)現(xiàn)對(duì)用戶的分級(jí)welcome精品2.2模塊關(guān)系圖電子商務(wù)系統(tǒng)前商訂登商臺(tái)品單陸品結(jié)顯管管注購(gòu)賬示理理冊(cè)買(mǎi)品熱打牌賣(mài)折種商促類品銷(xiāo)放生訂訂訂入成單單單購(gòu)訂修刪查物單改除詢車(chē)結(jié)用用賬戶戶返注登回添修刪查冊(cè)錄首加改除詢頁(yè)商商商商品品品品提示： 參考體系

7、結(jié)構(gòu)設(shè)計(jì)文檔welcome精品3. 子系統(tǒng)前臺(tái)的模塊設(shè)計(jì)模塊名稱用戶登錄功能描述普通用戶的登錄，接口與屬性函數(shù)帶三個(gè)參數(shù)：用戶ID 、用戶密碼、用戶類型數(shù)據(jù)結(jié)構(gòu)與算法采用“順序查找”的方法補(bǔ)充說(shuō)明查找是否有此用戶時(shí)，把參數(shù)與數(shù)據(jù)庫(kù)的參數(shù)做對(duì)比，是否一致模塊名稱客戶注冊(cè)功能描述給予客戶注冊(cè)會(huì)員接口與屬性函數(shù)帶三個(gè)參數(shù)：用戶ID 、用戶密碼、用戶郵箱、驗(yàn)證碼數(shù)據(jù)結(jié)構(gòu)與算法無(wú)補(bǔ)充說(shuō)明用戶密碼與驗(yàn)證碼是否一致模塊名稱分類搜索功能描述搜索相關(guān)產(chǎn)品接口與屬性產(chǎn)品型號(hào)的參數(shù)數(shù)據(jù)結(jié)構(gòu)與算法采用“順序查找”的方法補(bǔ)充說(shuō)明搜索時(shí)忽略空字符，如果沒(méi)有則提示“搜索不到該信息“welcome精品模塊名稱聊天功能描述咨詢客服相關(guān)信息接口與屬性QQ 所需一些參數(shù)模塊名稱購(gòu)物車(chē)功能描述查看要購(gòu)買(mǎi)的產(chǎn)品接口與屬性刪除物品、返回、結(jié)賬參數(shù)模塊名稱訂單查詢功能描述查詢相關(guān)產(chǎn)品接口與屬性訂單號(hào)的參數(shù)數(shù)據(jù)結(jié)構(gòu)與算法采用“順序查找”的方法補(bǔ)充說(shuō)明搜索時(shí)忽略空字符4. 子系統(tǒng)后臺(tái)的模塊設(shè)計(jì)模塊名稱用戶管理功能描述對(duì)用戶的添加，刪除，修改接口與屬性利用數(shù)據(jù)控件對(duì)數(shù)據(jù)庫(kù)修改等。數(shù)據(jù)結(jié)構(gòu)與算法無(wú)補(bǔ)充說(shuō)明模塊名稱訂單管理welcome精品功能描述對(duì)訂單刪除，修改接口與屬性利用數(shù)據(jù)控件對(duì)數(shù)據(jù)庫(kù)修改等數(shù)據(jù)結(jié)構(gòu)與算法