網(wǎng)上訂餐系統(tǒng)編碼實現(xiàn)目錄TOC\o"1-5"\h\z網(wǎng)上訂餐系統(tǒng)概要設(shè)計1\o"CurrentDocument"目錄2\o"CurrentDocument"導(dǎo)言4\o"CurrentDocument"目的4范圍4縮寫說明4\o"CurrentDocument"14術(shù)語定義4\o"CurrentDocument"引用標(biāo)準(zhǔn)5\o"CurrentDocument"參考資料5\o"CurrentDocument"版本更新信息5系統(tǒng)框架錯誤!未定義書簽。系統(tǒng)功能錯誤!未定義書簽。管理員功能錯誤!未定義書簽。32客戶功能錯誤!未定義書簽。界面設(shè)計錯誤!未定義書簽。管理端操作界面錯誤!未定義書簽?？蛻舳瞬僮鹘缑驽e誤!未定義書簽。體系結(jié)構(gòu)錯誤!未定義書簽。體系結(jié)構(gòu)錯誤!未定義書簽。struct體系結(jié)構(gòu)錯誤!未定義書簽。系統(tǒng)體系結(jié)構(gòu)錯誤!未定義書簽。系統(tǒng)進(jìn)行環(huán)境錯誤!未定義書簽。網(wǎng)絡(luò)結(jié)構(gòu)圖錯誤!未定義書簽。硬件環(huán)境錯誤!未定義書簽。軟件環(huán)境錯誤!未定義書簽。數(shù)據(jù)模型錯誤!未定義書簽。系統(tǒng)E-R圖設(shè)計錯誤!未定義書簽。數(shù)據(jù)庫的邏輯結(jié)構(gòu)模型設(shè)計錯誤!未定義書簽。數(shù)據(jù)庫物理結(jié)構(gòu)模型設(shè)計錯誤!未定義書簽。模塊設(shè)計錯誤!未定義書簽?？蛻舳四K設(shè)計錯誤!未定義書簽。表示層設(shè)計錯誤!未定義書簽。控制層錯誤!未定義書簽。模型層錯誤!未定義書簽。72系統(tǒng)管理模塊設(shè)計錯誤!未定義書簽。表示層設(shè)計錯誤!未定義書簽。控制層設(shè)計錯誤!未定義書簽。會員管理模塊設(shè)計錯誤!未定義書簽。表示層設(shè)計錯誤!未定義書簽?？刂茖釉O(shè)計錯誤!未定義書簽。菜看管理模塊設(shè)計錯誤!未定義書簽。錯誤!未定義書簽。錯誤!未定義書簽。錯誤!未定義書簽。6表示層設(shè)計控制層設(shè)計模型層設(shè)計簽字錯誤!未定義書簽。錯誤!未定義書簽。錯誤!未定義書簽。61.導(dǎo)言1.1.目的該文檔的目的是描述網(wǎng)上訂餐系統(tǒng)項目的編碼規(guī)范和對代碼的說明，其主要內(nèi)容包括:編碼規(guī)范命名規(guī)范注釋規(guī)范語句規(guī)范聲明規(guī)范目錄設(shè)置代碼說明本文檔的預(yù)期的讀者是:開發(fā)人員項目管理人員質(zhì)量保證人員12范該文檔定義了本項目的代碼編寫規(guī)范，以及部分代碼描述和所有代碼的說明。13縮寫說明14術(shù)語定義1.5.引用標(biāo)準(zhǔn)《企業(yè)文檔格式標(biāo)準(zhǔn)》北京長江軟件有限公司《Java語言編寫規(guī)范》北京長江軟件有限公司軟件工程過程化組織1.6.參考資料《實戰(zhàn)struct》〔美）TedHusted機械工業(yè)出版社《軟件重構(gòu)》清華大學(xué)出版社1-7.版本更新信息本文檔的更新記錄如下表。修改編號修改日期修改后版本修改位置修改內(nèi)容概述00120全部初始發(fā)布版本00220細(xì)節(jié)增加00320細(xì)節(jié)修改00420細(xì)節(jié)修改00520細(xì)節(jié)增加命名規(guī)范命名規(guī)范使程序更易讀，從而更易于理解。它們也可以提供一些有關(guān)標(biāo)識符功能的信息，以助于理解代碼。(Packages)(Packages)一個包名的前綴總是全部小寫的ASCII字母并且是f頂級域名，通常是com,edu,gov,inil,net,org,或1981年ISO3166標(biāo)準(zhǔn)所指定的標(biāo)識國家的英文雙字符代碼。包名的后續(xù)部分根據(jù)不同機構(gòu)各自內(nèi)部的命名規(guī)范而不盡相同。這類命名規(guī)范可能以特定目錄名的組成部門(department)，項目(project),機器(machine),或注冊名(loginnames)0如：Com.sun.22類(Classes)類名是一個名詞，采用大小寫混合的方式，每個單詞的首字母大寫。盡量使你的類名簡潔而富于描述。使用完整單詞，避免縮寫詞(除非該縮寫詞被更廣泛使用，像URL,HTML\接口(Interfaces)大小寫規(guī)則與類名相似。方法(Methods)方法名是一個動詞，采用大小寫混合的方式，第一個單詞的首字母大寫，其后單詞的首字母大寫。變量(Variabies)采用大小寫混合的方式，第一個單詞的首字母小寫，其后單詞的首字母大寫。變量名不應(yīng)以下劃線或美元符號開頭，盡管這在語法上是允許的。變量名應(yīng)簡短且富于描述。變量名的選用應(yīng)該易于記憶，即，能夠指出其用途。盡量避免單個字符的變量名,除非是一次性的臨時變量。臨時變量通常被取名為1,J,k,m和n,它們一般用于整形；c,d,e,它們一般用于字符型。實例變量(InstanceVariables)除了前面需要一個下劃線，大小寫規(guī)則和變量名相似，如：int_employeeldo常量(Constants)美常量和ANSI常量的聲明,應(yīng)該全部大寫,單詞間用下劃線隔開。聲明規(guī)范.1每行聲明變量的數(shù)量推薦一行一個聲明，因為這樣以利于寫注釋。亦即：Intleve1;//indentationlevelIntsize;//sizeoftable要優(yōu)于：不要將不同類型變量的聲明放在同一行，例如：Litfoo,fooanay[];//WRONG!注意：上面的例子中，在類型和標(biāo)識符之間放了一個空格?？崭窨墒褂弥票矸娲?2初始化盡量在聲明局部變量的同時初始化。唯一不這么做的理由是變量的初始值依賴于某先前發(fā)生的計算。3.3.布局只在代碼塊的開始處聲明變量(一個塊是指任何被包含在大括號〃{“和〃r中間的代碼\不要在首次用到該變量時才聲明之。這會把注意為不集中的程序員搞糊涂，同時會妨礙代碼在該作用域內(nèi)的可移植性。voidmyMethod(){intint1=0;〃方法(代碼塊)開始處聲明變量iRcondition){intint2=0;〃if代碼塊開始處聲明變量}該規(guī)則的f例夕卜是for循環(huán)的索引變量；for(inti=0;ivmaxLoops;i++){…}34包的聲明在多數(shù)Java源文件中,第一個非注釋行是包語句。當(dāng)編寫類的接口時,應(yīng)該遵守以下格式規(guī)則：?在方法名與其參列表之前的左括號〃("間不要有空格；?左大括號〃{"們于聲明語句同行的末尾；?右大括號〃r另起一行，與相應(yīng)的聲明語句對齊，除非是一個空語句，〃r應(yīng)緊跟在〃}〃之后；，方法與方法之間以空行分隔。注釋規(guī)范Java程序有兩類注釋：實現(xiàn)注釋(implementationcomments)和文檔注釋(documentcomments)o實現(xiàn)注釋使用/*..?*/界定的注釋。文檔注釋(被稱為"doccomments")是Java獨有的，并由/**..?*/界定。文檔注釋可以通過javadoc工具轉(zhuǎn)換成HTML文件，描述Java的美、接口、構(gòu)造器、方法以及字段(field)。一個注釋對應(yīng)f類、接口或成員。若你想給出有關(guān)美、接口、變量或方法的信息，而這些信息又不適合寫在文檔中，則可使用實現(xiàn)塊注釋或緊跟在聲明后面的單行注釋。例如,有關(guān)一個類實現(xiàn)的細(xì)節(jié)，應(yīng)放入緊跟在類聲明后面的實現(xiàn)塊注釋中，而不是放在文檔注釋中。注釋應(yīng)被用來給出代碼的總括，并提供代碼自身沒有提供的附加信息。在注釋里，對設(shè)計決策中重要的或者不是顯而易見的地方進(jìn)行說明是可以的，但應(yīng)避免提供代碼中已清晰表達(dá)出來的重復(fù)信息。4.1.注釋的方法程序可以有4種實現(xiàn)注釋的風(fēng)格:塊注釋、單行注釋、尾端注釋和行末注釋。1)塊注釋塊注釋通常用于提供對文件，方法,數(shù)據(jù)結(jié)構(gòu)和算法的描述。塊注釋被置于每個文件的開始處以及每個方法之前。它們也可以被用于其他地方，比如方法內(nèi)部。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進(jìn)格式。塊注釋之首應(yīng)該有一個空行。用于把塊注釋和代碼分割開來，比如:/**這是塊注釋(Hereisablockcomment.)*/publicclassExample{...}注意頂層(top.level)的美和接口是不縮進(jìn)的,而其成員是縮進(jìn)的。描述類和接口的文檔注釋的第一行(/**)不需縮進(jìn)，隨后的文檔注釋每行都縮進(jìn)1格(使星號縱向?qū)R\成員，包括構(gòu)造函數(shù)在內(nèi)，其文檔注釋的第一行縮進(jìn)4格,隨后每行都縮進(jìn)5格。單行注釋短注釋可以顯示在一行內(nèi)，并與其后的代碼具有一樣的縮進(jìn)層級。如果一個注釋不能在一行內(nèi)寫完,就該采用塊注釋(參見〃塊注釋〃\單行注釋之前應(yīng)該有一個空行。以下是一個Java代碼中單行注釋的例子：ifcondition(/*條件處理(Handlethecondition.)*/???}尾端注釋極短的注釋可以與它們所要描述的代碼位于同一行，但是應(yīng)該有足夠的空曰來分開代碼和注釋。若有多個短注釋出現(xiàn)于大段代碼中,它們應(yīng)該具有相同的縮進(jìn)。以下是一個Java代碼中尾端注釋的例子:iRinput==2){returnTRUE;/*特殊處理*/)else(returniiiMine(input);/*調(diào)用函數(shù)isMine*/4）行末注釋注釋界定符’7/〃可以注釋掉整行或者一行中的一部分。它一般不用于連續(xù)多行的注釋文本然而，它可以用來注釋掉連續(xù)多行的代碼段。注意：?頻繁的注釋有時反映出代碼的低質(zhì)量。當(dāng)你覺得被迫要加注釋的時候,考慮一下重寫代碼使其更清晰；?注釋不應(yīng)寫在用星號或其他字符畫出來的大框里。注釋不應(yīng)包括諸如制表符和回退符之美的特殊字符。42開頭注釋所有的源文件都應(yīng)該在開頭有一個類似C語言風(fēng)格的注釋，其中列出美名、版本信息、日期、作者以及版權(quán)聲明。我們的網(wǎng)上訂餐系統(tǒng)采用的頭注釋統(tǒng)一為:/***@System:OnlineCVSystem*@Version:1.0*@Copyright@2009bychangjiangcompany,Inc.AllRightsReseived.*@Class:ValidateSessionTag*@Summary:對用戶的身份驗證*@Create:2005.05.02江明*@Update:2005.05.02江明*/43類和接口的注釋美/接口文檔注釋(/**……*/):該注釋中所需包含的信息，參見"LogonAction.java”。美/接口實現(xiàn)的注釋(/**……*/):如果有必要的話，該注釋應(yīng)包含任何有關(guān)整個類或接口的信息，而這些信息又不適合作為美/接口文檔注釋。6.代碼范例/***@System:OnlineCVSystem*@Version:1.0*@Copyright@2009bychangjiangcompany,Inc.AllRightsReseived.*@Summary:循環(huán)打印用戶信息*@Create:2005.05.28馮飛*@Update:*/<&@pagelangiiage="javan&><&@tagliburi=,,/stn.icts/tags-bean,,prefix="bean"&><&@taglibini=t4ittp:///stnicts/tags-htmrtprefix=nhtinlH&><htinl><head><title>JSPfbrsampleFonnfbrm</title></head><body>JV&?-判斷用戶信息??&><logic:presentname=HSampleFormnpropeity=nusreListn>v&.-循環(huán)顯示用戶信息..&><logic:iterateid=nusernname=SampleFormHpropeity=nuserListn><tr><td><bean:writename=nusernpropeity=Hidt7x/td><td><bean:writename=nusernpropeity=Hnamel7></td><tr></logic:iterate></logic:present></bodv>目錄規(guī)范開發(fā)環(huán)境是eclipse,開發(fā)之后的代碼需要部署到Tomcat服務(wù)器環(huán)境上。所以開發(fā)環(huán)境的目錄結(jié)構(gòu)與運行環(huán)境的目錄結(jié)構(gòu)是一致的，只是在部署的運行環(huán)境中，可以不設(shè)置源代碼的目錄。為此制