項目指導書(第一學期)

1、目 錄 項目案例1應用場景1項目基本需求描述2系統(tǒng)核心業(yè)務流程2原始資料3項目運行環(huán)境4文檔范例5開發(fā)文檔6項目任務書6項目進展報告（每個階段提交一份報告）6個人變更記錄7用戶界面檢查表7軟件總體設計文檔9測試計劃14測試報告15Java編碼規(guī)范161 介紹(Introduction)162 文件名()163 文件組織()174 縮進排版(Indentation)185 注釋(Comments)206 聲明(Declarations)237 語句(Statements)258 空白(White Space)289 命名規(guī)范(Naming Conventions)2910 編程慣例(Progra

2、mming Practices)3111 代碼范例(Code Examples)33項目案例 應用場景 Sunny Sport運動時尚成立于1990年，是NIKE品牌在中南地區(qū)最早的經(jīng)銷商，此外，公司還經(jīng)營世界品牌“Adidas”等。Sunny Sport運動時尚在中南各大型商場都設有專柜，主要經(jīng)營NIKE、Adidas、Reebok、Puma、李寧、安踏等二十幾個體育品牌，是體育愛好者購物的天堂。隨著北京2008年奧運會的成功舉辦以及人均收入的不斷提高，中國體育產(chǎn)業(yè)面臨巨大的商機和挑戰(zhàn)。公司目前共有資產(chǎn)8000萬。店鋪50余家，年銷售值達數(shù)億元?！疤峁﹥?yōu)質服務，共享健康人生”的企業(yè)理念是Su

3、nny Sport對體育事業(yè)不懈追求的體現(xiàn)，Sunny Sport所有同仁將全心投入，和所有國人一起推動全民健身運動。Sunny Sport運動時尚在未來的幾年時間內發(fā)展目標是在國內建立10個以上的省級分公司，中南地區(qū)的分店數(shù)量目標在百家左右，成為全國范圍內的較大的運動品牌連鎖企業(yè)。面對這樣的發(fā)展計劃，首先是日常運營業(yè)務流程上必須大幅度調整，核算體系和物流體系要有本質的變化，而且公司的管理模式和組織結構也需要優(yōu)化重組。為此，公司高層決定開發(fā)一套進銷存管理系統(tǒng)，提高工作效率，更好地實行科學化的管理。該系統(tǒng)開發(fā)過程分為幾個階段，其中第一階段的主要任務是完成商品管理、客戶管理、供應商管理、庫存管理和

4、系統(tǒng)管理和報表生成；第二階段的主要任務是完成采購管理、銷售管理、配送管理、賬務管理等；第三階段增加經(jīng)營狀況分析與決策等功能，讓該系統(tǒng)具備決策支持系統(tǒng)(DSS)的功能。由于第一階段是整個系統(tǒng)的核心，作為該進銷存系統(tǒng)的重點模塊，本需求主要針對第一階段開發(fā)任務而制定?，F(xiàn)計劃采用的是二層客戶端/服務器(C/S)結構來進行本系統(tǒng)的第一階段開發(fā)。 二層的C/S結構是指以單一的服務器和局域網(wǎng)為核心，能通過客戶端與用戶進行直接交互，用于檢查用戶從鍵盤等輸入的數(shù)據(jù)，顯示應用輸出的數(shù)據(jù)，客戶端負責用戶界面的顯示和業(yè)務的處理；服務器端主要用于數(shù)據(jù)管理，充當數(shù)據(jù)庫服務器的角色。為使用戶能直觀地進行操作，一般要使用圖形

5、用戶接口(GUI)，操作簡單、易學易用。典型的二層C/S結構有以下特點：1、服務器負責數(shù)據(jù)管理及數(shù)據(jù)存儲；2、客戶機負責界面描述和界面顯示；3、客戶機向服務器提出數(shù)據(jù)處理要求；4、服務器響應將數(shù)據(jù)處理結果返回客戶機；5、使網(wǎng)絡數(shù)據(jù)流量最少。項目基本需求描述 n 商品類別管理：查看、增加、刪除、修改商品類別，類別分為兩級，包括主類別和次類別，參考分類：服裝à運動服、休閑服、籃球服、健身服、登山服、運動裙；鞋子à足球鞋、籃球鞋、跑步鞋、休閑鞋、登山鞋、溜冰鞋、全能鞋；。n 商品管理：根據(jù)類別查看商品資料、根據(jù)商品名稱或編號查詢商品詳細信息、根據(jù)商品品牌查看商品資料；增加、刪除、

6、修改商品資料。各商品庫存需設置上限和下限，在入庫與出庫時提供庫存警報機制，提醒操作人員該商品庫存已經(jīng)處于臨界狀態(tài)。n 供應商管理：查看、增加、刪除、修改供應商資料。n 入庫管理：增加、刪除、修改入庫單，生成詳細的入庫單明細；入庫單信息包括入庫單編號、入庫日期和時間、入庫人編號、供應商編號等；同時提供入庫單明細管理，入庫單明細包括入庫單編號、商品編號、數(shù)量、折扣等信息。n 客戶管理：查看、增加、刪除、修改客戶資料。n 出庫管理：增加、刪除、修改出庫單，生成詳細的出庫單明細；出庫單信息包括出庫單編號、出庫日期和時間、出庫人編號、客戶編號等；同時提供出庫單明細管理，出庫單明細包括出庫單編號、商品編號

7、、數(shù)量、折扣等信息。n 系統(tǒng)管理：查看、增加、刪除、修改系統(tǒng)管理員。（本系統(tǒng)簡化權限管理功能，系統(tǒng)管理員既可以作為入庫人，也可以作為出庫人；可增加權限管理，系統(tǒng)管理員可增加操作人員，并可授權入庫、出庫和系統(tǒng)管理等功能；如果實現(xiàn)可以作為擴展功能。）n 報表功能：能夠生成每日庫存報表和每日財務報表。系統(tǒng)核心業(yè)務流程 n 入庫：管理員登錄后可進行入庫操作，每次處理一個入庫單，系統(tǒng)自動記錄入庫日期和時間、入庫人（即管理員）、系統(tǒng)自動生成入庫單編號，入庫單記錄供應商基本信息（供應商編號、名稱、聯(lián)系人、聯(lián)系電話、聯(lián)系地址等），可以通過選取供應商編號或名稱自動從數(shù)據(jù)庫獲取這些信息，如果供應商不存在，必須先添

8、加該供應商信息。一個入庫單對應多個入庫明細，每一種商品的明細包括該商品的編號、名稱、類別、單價、數(shù)量、碼洋（原始價格）、折扣和實洋（折后價格）。入庫單顯示總碼洋和實收金額。在入庫時如果商品數(shù)量超過該商品庫存上限，提供庫存報警提示，該商品入庫操作不成功。n 出庫：管理員登錄后可進行出庫操作，每次處理一個出庫單，系統(tǒng)自動記錄出庫日期和時間、出庫人（即管理員）、系統(tǒng)自動生成出庫單編號，出庫單記錄客戶基本信息（客戶編號、名稱、聯(lián)系人、聯(lián)系電話、聯(lián)系地址等），可以通過選取客戶編號或名稱自動從數(shù)據(jù)庫獲取這些信息，如果客戶不存在，必須先添加該客戶信息。一個出庫單對應多個出庫明細，每一種商品的明細包括該商品的

9、編號、名稱、類別、單價、數(shù)量、碼洋（原始價格）、折扣和實洋（折后價格）。出庫單顯示總碼洋和實收金額。在出庫時如果商品數(shù)量低于該商品庫存下限，提供庫存報警提示，該商品出庫操作不成功。原始資料 n 入庫單：Sunny Sport運動時尚入庫清單入庫單編號：SSI0001日期：2008-10-11時間：14:30入庫人：張三供應商編號：P001名稱：安踏長沙公司聯(lián)系人：李四電話：手機：傳真：地址：長沙雨花區(qū)郵編：410001總數(shù)量（件）：45件總碼洋：7500.00元實付金額： 4500.00元折扣額：3000元編號商品名稱類別單價數(shù)量碼洋折扣實洋SF001安踏足球鞋S001鞋子(足球鞋)200.0

10、051000.0060%600.00FC002安踏休閑褲FC002褲子(休閑褲)100.00101000.0060%600.00BB013安踏籃球服BB013服裝(籃球服)250.00102500.0060%1500.00FB089安踏足球服FB089服裝(足球服)150.00203000.0060%1800.00n 出庫單：Sunny Sport運動時尚出庫清單出庫單編號：SSO0001日期：2008-10-12時間：9:30出庫人：張三客戶編號：C001名稱：長沙一中聯(lián)系人：王五電話：手機：傳真：地址：長沙開福區(qū)郵編：410002總數(shù)量（件）：20件總碼洋：4000.00元實收金額： 32

11、00.00元折扣額：800元編號商品名稱類別單價數(shù)量碼洋折扣實洋BB013安踏籃球服BB013服裝(籃球服)250.00102500.0080%2000.00FB089安踏足球服FB089服裝(足球服)150.00101500.0080%1200.00n 每日庫存報表：Sunny Sport運動時尚每日庫存報表日期：2008-10-20類別編號商品名稱原庫存日入庫日出庫現(xiàn)庫存上限下限鞋子(足球鞋)SF001安踏足球鞋S00110201020505褲子(休閑褲)FC002安踏休閑褲FC002150510505服裝(籃球服)BB013安踏籃球服BB0131010020505服裝(足球服)FB089

12、安踏足球服FB08920101020505n 每日財務報表：Sunny Sport運動時尚每日財務報表日期：2008-10-20總實付金額：12000.00元總實收金額：22400.00元清單編號類別總碼洋實付金額實收金額折扣額SSI0001入庫4000.002400.000.001600.00SSI0002入庫6000.003600.000.002400.00SSO0001出庫8000.000.006400.001600.00SSI0003入庫10000.006000.000.004000.00SSO0002出庫20000.000.0016000.004000.00項目運行環(huán)境 服務器軟硬件

13、要求（最低配置）軟件：n Windows 2000及以上n TCP/IP協(xié)議硬件：n CPU: PIII及以上n 內存：512M以上n 硬盤：10G以上客戶機軟硬件要求軟件：n Windows 98/ME/2000及以上n TCP/IP協(xié)議硬件：n CPU: PIII及以上n 內存：最少128Mn 硬盤：4G以上文檔范例 n 文檔文檔是計算機編程最重要的方面之一。大多數(shù)已經(jīng)完成了程序編寫、測試和實現(xiàn)的程序員獲得解脫般太過著急地進入下一個項目。另一方面，程序用戶抱怨文檔老是不完整、不精確或者不正確。僅由程序作者調試程序的情況很少。如果程序沒有輸入/輸出要求、如何執(zhí)行程序、特定部分的代碼做什么之類

14、的詳細信息，那么其他用戶就很難進行程序調試。因此文檔的目的就是要指導用戶全面了解程序以及如何正確使用它。文檔應在哪個階段書寫呢？大多數(shù)情況是在項目結束時才補上的。結果，文檔就是些倉促的注解列表，再加上很少的程序運行指導。這個層次所提供的信息不充分，因此項目間的單元測試和檢查的想法將有助于制定一份有效和有用的文檔。n 程序文檔維護計算機程序的主要原因有兩個。第一個是由于我們沒有能力寫出完全沒有錯誤的大型程序所產(chǎn)生的后果；也就是程序bug的定位和改正。錯誤檢測在許多情況下是一個貫徹程序整個生命周期的過程。大多數(shù)錯誤在正式的調試和測試過程中被發(fā)現(xiàn)和改正，然后才認為程序完成了。第二個原因是修改現(xiàn)有程序

15、以適應規(guī)范的改變。必須修改程序才能滿足不斷變化的用戶需求，才能對程序進行完善。要滿足程序文檔標準，保留用指定詳細信息更新過的每個單元的注釋頁對程序員而言非常有用，這使得項目文檔任務變得非常容易。n 項目文檔文檔是團隊工作的一個重要方面。對于將可重用性作為首要益處的面向對象方法而言更是如此。創(chuàng)建者對一個通用類所作的任何修改應該立即寫入文檔，這樣該類的用戶就能注意到。應對文檔進行更好的文字處理和適當歸檔。文檔結構應該包括：n 封面頁，應具有項目名稱、項目小組成員名字及他們的批號和注冊號、提交日期、總頁數(shù)（每頁文檔都要有頁碼）。n 問題陳述的簡要描述。n 分析和設計，這需要E/R圖、類定義和具有意義

16、字段名的表結構。n 用于測試的樣本數(shù)據(jù)和程序清單。所有這些信息以及新的程序描述和任何有益于程序理解的其它注釋都應整理并添加到文檔文件中，這樣就能對接管該程序或項目且必須重新理解其工作機制的其他人提供幫助。n 參見文檔范例開發(fā)文檔 項目任務書 Sunny Sport庫存管理系統(tǒng)項目的任務進度計劃任務名稱工作人員工作時間任務描述需求分析開發(fā)組2009年2月10日-2009年2月16日根據(jù)用戶提出的需求，制訂比較詳細的需求分析報告文檔系統(tǒng)設計開發(fā)組2009年2月17日-2009年3月15日項目進展報告（每個階段提交一份報告） 項目進展報告項目名稱Sunny Sport庫存管理系統(tǒng)項目組長報告名稱需求

17、分析報告項目所處階段需求分析階段時間段2009年2月10日-2009年2月16日工作總結經(jīng)過項目組的詳細分析和討論，確定主要功能需求如下：管理員登錄商品類別管理商品管理入庫管理出庫管理供應商管理客戶管理系統(tǒng)管理報表功能問題與對策1. 問題： 庫存報警提示 對策：在系統(tǒng)中增加庫存檢查程序。 原因：個人變更記錄 個人變更記錄所屬項目Sunny Sport庫存管理系統(tǒng)變更標題變更內容說明變更內容以及相關技術。執(zhí)行人日期用戶界面檢查表 用戶界面檢查表設計要素重要性檢查項適合于檢查結果合適性非常重要用戶界面是否與軟件的功能相融洽？用戶界面是否適合于用戶的應用環(huán)境？解釋：如果否定的話，意味著用戶不能有效地

18、使用這個軟件，是不可原諒的缺陷。這個缺陷是需求分析錯誤造成的。評審測試容易理解非常重要（1）界面元素有錯別字，或者措詞含糊、邏輯混亂。（2）消息框的提示文字和按鈕在語義上不連貫。（3）確認消息框、告警消息框、通知消息框、過程消息框的風格混淆在一起。解釋：如果出現(xiàn)如此低級的缺陷，說明開發(fā)人員根本沒有把用戶界面放在心上，用戶很反感這種不敬業(yè)的態(tài)度。是不可原諒的缺陷。評審測試重要（1） 對于常用的功能，用戶能否不必閱讀手冊就能使用嗎？（2） 是否所有界面元素提供了充分而必要的提示？（3） 界面結構和工作流程匹配嗎？（4） 提供聯(lián)機幫助嗎？解釋：如果實現(xiàn)上述要求，說明界面的細節(jié)做得很好。評審測試及時反

19、饋信息重要（1） 是否提供進度條、動畫等反映正在進行的比較耗時間的過程？（2） 是否為重要的操作返回必要的結果信息？解釋：如果否定的話，說明用戶界面不夠專業(yè)。測試防錯處理非常重要（1） 執(zhí)行破壞性的操作之前，是否獲得用戶的確認？（2） 輸入數(shù)據(jù)或者遞交數(shù)據(jù)時，是否進行相應的數(shù)據(jù)校驗（檢查數(shù)據(jù)是否合法）（3） 是否根據(jù)用戶的權限自動隱藏或者禁用某些功能？解釋：如果否定的話，說明開發(fā)人員沒有防錯處理的常識，是不可原諒的缺陷。測試可選是否提供Undo功能用以撤銷不期望的操作？解釋：如果實現(xiàn)該要求，說明界面的細節(jié)做得很好。測試一致性重要（1） 同類的界面元素是否有相同的視感和相同的操作方式？（2） 是

20、否符合廣大用戶使用同類軟件的習慣？解釋：如果否定的話，說明用戶界面不夠專業(yè)。評審測試個性化可選是否在具備必要的“一致性”的前提下，設計了與眾不同的、讓用戶記憶深刻的界面？解釋：如果實現(xiàn)該要求，說明界面很有創(chuàng)意。評審測試合理布局可選（1） 界面的布局符合軟件的功能邏輯嗎？（2） 界面元素是否在水平或者垂直方向對齊？（3） 界面元素的尺寸是否合理？行、列的間距是否保持一致？（4） 是否恰當?shù)乩么绑w和控件的空白，以及分割線條？（5） 窗口切換、移動、改變大小時，界面正常嗎？解釋：如果否定的話，說明用戶界面不夠專業(yè)。評審測試合理色彩重要（1） 界面的色調是否讓人感到和諧、滿意？（2） 重要的對象是否

21、用醒目的色彩表示？（3） 色彩使用是否符合行業(yè)的習慣？（4） 是否可以讓色盲、色弱人員使用？解釋：如果實現(xiàn)該要求，說明界面細節(jié)很好。評審測試適應用戶群體可選（1） 初學者和專家都有合適的方式操作這個界面嗎？（2） 色盲或者色弱的用戶能正常使用該界面嗎？解釋：如果實現(xiàn)該要求，說明界面細節(jié)很好。測試國際化重要（1） 度量單位、日期格式、人的名字等是否讓用戶誤解？（2） 翻譯文字是否地道，是否符合讀者習慣？評審測試最少步驟最高效率重要是否用合理的最少步驟實現(xiàn)常用的操作，獲得高效率？解釋：如果實現(xiàn)該要求，說明界面細節(jié)很好。測試可復用重要用戶界面的原型、代碼、文檔是否可以被復用？解釋：如果實現(xiàn)該要求，說

22、明軟件的需求分析、設計、實現(xiàn)做得很好。開發(fā)團隊內部評估軟件總體設計文檔 0. 文檔介紹0.1 文檔目的與范圍編寫該文檔的目的在于明確Sunny Sport庫存管理系統(tǒng)的用戶需求，使得軟件開發(fā)人員與用戶對待開發(fā)軟件的需求有統(tǒng)一的、無二義性的認識。該文檔所描述的內容，可作為軟件確認測試的依據(jù)。該文檔的讀者為用戶代表、軟件分析人員、開發(fā)管理人員和測試人員。0.2 讀者對象閱讀對象：一般大眾0.3 參考文獻提示：列出本文檔的所有參考文獻（可以是非正式出版物），格式如下：標識符 作者，文獻名稱，出版單位（或歸屬單位），日期0.4 術語與縮寫解釋縮寫、術語解 釋1. 系統(tǒng)概述提示：（1）說明本系統(tǒng)“是什么

23、”，（2）描述本系統(tǒng)的主要功能。 Sunny Sport庫存管理系統(tǒng)是一個基于客戶機/服務器結構的兩層系統(tǒng)，系統(tǒng)主要功能包括入庫操作、出庫操作和系統(tǒng)管理等。采用JAVA編寫代碼，并使用JDBC訪問Oracle數(shù)據(jù)庫。2. 設計約束提示：（1）需求約束。體系結構設計人員從需求文檔（如用戶需求說明書和軟件需求規(guī)格說明書）中提取需求約束，例如：² 本系統(tǒng)應當遵循的標準或規(guī)范² 軟件、硬件環(huán)境（包括運行環(huán)境和開發(fā)環(huán)境）的約束² 接口/協(xié)議的約束² 用戶界面的約束² 軟件質量的約束，如正確性、健壯性、可靠性、效率（性能）、易用性、清晰性、安全性、可擴展性

24、、兼容性、可移植性等等。（2）隱含約束。有一些假設或依賴并沒有在需求文檔中明確指出，但可能會對系統(tǒng)設計產(chǎn)生影響，設計人員應當盡可能地在此處說明。例如對用戶教育程度、計算機技能的一些假設或依賴，對支撐本系統(tǒng)的軟件硬件的假設或依賴等。3. 開發(fā)與運行環(huán)境提示：說明本系統(tǒng)應當在什么樣的環(huán)境下開發(fā)和運行，有什么強制要求和建議？類別標準配置最低配置開發(fā)環(huán)境測試環(huán)境運行環(huán)境4. 軟件的總體設計提示： （1）將系統(tǒng)分解為若干子系統(tǒng)，繪制各種結構圖（例如層次結構圖、數(shù)據(jù)流圖），說明各子系統(tǒng)的主要功能。（盡可能簡單明了，但是能夠闡述清楚系統(tǒng)的結構）。（2）說明“如何”以及“為什么”（how and why）如此

25、分解系統(tǒng)。（3）說明各子系統(tǒng)如何協(xié)調工作，從而實現(xiàn)原系統(tǒng)的功能。4.1 結構圖A在確定本系統(tǒng)的基本結構后，本系統(tǒng)可劃分為以下幾個子模塊，其功能如下：Ø 登錄模塊 提交用戶登錄信息給服務器；根據(jù)服務器返回的結果決定用戶是否可以登錄。Ø 入庫模塊 增加、刪除、修改入庫單，生成詳細的入庫單明細。Ø 出庫模塊增加、刪除、修改出庫單，生成詳細的出庫單明細。5. 軟件體系的面向對象設計5.1用例圖5.2 類圖登錄模塊類圖6. 數(shù)據(jù)庫設計概述6.1 數(shù)據(jù)庫環(huán)境說明提示： 說明所采用的數(shù)據(jù)庫系統(tǒng)，設計工具，編程工具，有關配置等6.2 數(shù)據(jù)庫命名規(guī)則提示：說明表、字段等命名規(guī)則6.

26、3 安全性設計說明提示：考慮用戶密碼、訪問權限等等6.4 E/R圖mnordDateordTimeordAdminProductOrdercontainsordIDordTypeordTradeIDodDiscountodAmountodPricepNamepUlimitpAmountpLlimitpSubTypeIDpMainTypeIDpIDpPrice6.5 表匯總n 管理員信息表(Admin)字段字段名數(shù)據(jù)類型長度能否為空備注aAccount管理員賬號varchar220NOT NULLPKaPassword管理員密碼varchar220NOT NULLaName管理員姓名pvarch

27、ar28NOT NULLaTel管理員聯(lián)系電話varchar220n 商品信息表(Product)字段字段名數(shù)據(jù)類型長度能否為空備注pID商品編號varchar220NOT NULLPKpName商品名稱varchar220NOT NULLpMainTypeID商品主類別編號varchar210NOT NULLFKpSubTypeID商品次類別編號varchar210NOT NULLFKpPrice商品原始單價number10NOT NULLpAmount商品數(shù)量number5NOT NULLpUlimit商品庫存上限number5NOT NULLpLlimit商品庫存下限number5NOT

28、 NULLn 訂單表(Order)字段字段名數(shù)據(jù)類型長度能否為空備注ordID訂單編號varchar220NOT NULLPKordDate日期DateNOT NULLordTime時間DateNOT NULLordAdmin出/入庫人varchar220NOT NULLFKordType訂單類型varchar24NOT NULL出庫單或者入庫單ordTradeID供/訂貨者編號number20NOT NULLFKn 訂單明細表(OrderDetail)字段字段名數(shù)據(jù)類型長度能否為空備注ordID訂單編號varchar220NOT NULLPK、FKpID商品編號varchar220NOT N

29、ULLPK、FKodAmount商品數(shù)量number6NOT NULLodDiscount商品折扣number6NOT NULLodPrice商品價格number10NOT NULL訂單中的商品價格7. 用戶界面設計概述提示：說明界面設計要素，注意事項，界面原型等。1、登錄界面控制條件值預期結果實際結果結論整理按鈕“登錄”表中存在該用戶并且密碼正確被點擊進入主界面，并且名字顯示在主界面上YESOKOK按鈕“重置”None被點擊清除已經(jīng)輸入的賬號和密碼YESOKOK8. 綜合考慮8.1 穩(wěn)定性和可擴展性提示：在“軟件”生命周期內，判斷哪些需求是不變的，預測哪些需求可能發(fā)生的變化。在總體設計的時候

30、，既要使總體結構穩(wěn)定，又要適應需求變化。8.2 性能分析提示：（1）本系統(tǒng)應當具備哪些性能指標才能滿足用戶的需求？（2）如何實現(xiàn)性能指標？8.3 復用和移植提示：（1）本系統(tǒng)復用了什么東西（說明出處）？如何解決被復用成果的質量問題？（2）本系統(tǒng)中哪些東西是可以被將來的系統(tǒng)復用的？有什么構思？（3）如何使本系統(tǒng)的功能代碼和用戶界面代碼區(qū)分開來8.4 防錯與出錯處理提示：（1）如何預防系統(tǒng)出錯？（2）如果系統(tǒng)出錯了，如何處理以減少危害？8.5 其它測試計劃 1. 測試范圍提示：系統(tǒng)測試小組應當根據(jù)項目的特征確定測試類型和主要內容。一般地，系統(tǒng)測試的主要類型包括功能測試、健壯性測試、性能測試、用戶界

31、面測試、安全性（security）測試、安裝與反安裝測試等。測試類型測試內容、描述2. 測試方法提示：例如黑盒測試和白盒測試，解說方法。3. 測試環(huán)境與測試輔助工具測試環(huán)境測試輔助工具4. 測試完成準則提示：對于非嚴格系統(tǒng)可以采用“基于測試用例”的準則： （1）功能性測試用例通過率達到100；（2）非功能性測試用例通過率達到95時。對于嚴格系統(tǒng)，應當補充“基于缺陷密度”的規(guī)則：（3）相鄰n個CPU小時內“測試期缺陷密度”全部低于某個值m。例如n大于10，m小于等于1。5. 人員與任務表任務描述時間人員6. 問題與對策7. 本計劃審批意見提示：如果公司有測試經(jīng)理的話，本計劃需要測試經(jīng)理的審批。項

32、目經(jīng)理審批意見：測試經(jīng)理審批意見：測試報告 測試報告項目名稱Sunny Sport庫存管理系統(tǒng)測試任務描述管理員登錄功能測試人員張三測試時間2009-3-28測試環(huán)境和工具Windows XP測試用例或測試內容結果說明用戶名為空（1）無bug（2）發(fā)現(xiàn)bug ü（3）已消除bug沒有任何錯誤提示。測試總結Java編碼規(guī)范 1 介紹(Introduction) n 為什么要有編碼規(guī)范(Why Have Code Conventions)編碼規(guī)范對于程序員而言尤為重要，有以下幾個原因：- 一個軟件的生命周期中，80%的花費在于維護。- 幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的

33、開發(fā)人員來維護。- 編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼。- 如果你將源碼作為產(chǎn)品發(fā)布，就需要確任它是否被很好的打包并且清晰無誤，一如你已構建的其它任何產(chǎn)品。為了執(zhí)行規(guī)范，每個軟件開發(fā)人員必須一致遵守編碼規(guī)范。n 1.2 版權聲明(Acknowledgments)本文檔反映的是Sun MicroSystems公司Java語言規(guī)范中的編碼標準部分。主要貢獻者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。本文檔現(xiàn)由Scott Hommel維護，

34、。2 文件名() 這部分列出了常用的文件名及其后綴。n 2.1 文件后綴()Java程序使用下列文件后綴：文件類別文件后綴Java源文件.javaJava字節(jié)碼文件.classn 2.2 常用文件名(Common )常用的文件名包括：文件名用途GNUmakefilemakefiles的首選文件名。我們采用gnumake來創(chuàng)建（build）軟件。README概述特定目錄下所含內容的文件的首選文件名3 文件組織() 一個文件由被空行分割而成的段落以及標識每個段落的可選注釋共同組成。超過2000行的程序難以閱讀，應該盡量避免?！癑ava源文件范例”提供了一個布局合理的Java程序范例。n 3.1 J

35、ava源文件(Java Source Files)每個Java源文件都包含一個單一的公共類或接口。若私有類和接口與一個公共類相關聯(lián)，可以將它們和公共類放入同一個源文件。公共類必須是這個文件中的第一個類或接口。Java源文件還遵循以下規(guī)則：- 開頭注釋（參見“開頭注釋”）- 包和引入語句（參見“包和引入語句”）- 類和接口聲明（參見“類和接口聲明”） 3.1.1 開頭注釋(Beginning Comments)所有的源文件都應該在開頭有一個C語言風格的注釋，其中列出類名、版本信息、日期和版權聲明： /* * Classname * * Version information * * Date *

36、 * Copyright notice */ 3.1.2 包和引入語句(Package and Import Statements)在多數(shù)Java源文件中，第一個非注釋行是包語句。在它之后可以跟引入語句。例如： package java.awt; import java.awt.peer.CanvasPeer; 3.1.3 類和接口聲明(Class and Interface Declarations)下表描述了類和接口聲明的各個部分以及它們出現(xiàn)的先后次序。參見“Java源文件范例”中一個包含注釋的例子。 類/接口聲明的各部分注解1類/接口文檔注釋(/*/)該注釋中所需包含的信息，參

37、見“文檔注釋”2類或接口的聲明 3類/接口實現(xiàn)的注釋(/*/)如果有必要的話該注釋應包含任何有關整個類或接口的信息，而這些信息又不適合作為類/接口文檔注釋。4類的(靜態(tài))變量首先是類的公共變量，隨后是保護變量，再后是包一級別的變量(沒有訪問修飾符，access modifier)，最后是私有變量。5實例變量首先是公共級別的，隨后是保護級別的，再后是包一級別的(沒有訪問修飾符)，最后是私有級別的。6構造器 7方法這些方法應該按功能，而非作用域或訪問權限，分組。例如，一個私有的類方法可以置于兩個公有的實例方法之間。其目的是為了更便于閱讀和理解代碼。4 縮進排版(Indentat

38、ion) 4個空格常被作為縮進排版的一個單位?？s進的確切解釋并未詳細指定(空格 vs. 制表符)。一個制表符等于8個空格(而非4個)。n 4.1 行長度(Line Length)盡量避免一行的長度超過80個字符，因為很多終端和工具不能很好處理之。注意：用于文檔中的例子應該使用更短的行長，長度一般不超過70個字符。n 4.2 換行(Wrapping Lines)當一個表達式無法容納在一行內時，可以依據(jù)如下一般規(guī)則斷開之：- 在一個逗號后面斷開- 在一個操作符前面斷開- 寧可選擇較高級別(higher-level)的斷開，而非較低級別(lower-level)的斷開- 新的一行應該與上一行同一級別

39、表達式的開頭處對齊- 如果以上規(guī)則導致你的代碼混亂或者使你的代碼都堆擠在右邊，那就代之以縮進8個空格。 以下是斷開方法調用的一些例子： someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3);以下是兩個斷開算術表達式的例子。前者更好，因為斷開處位于括號表達式的外邊，這是個較高級別的斷開。 longN

40、ame1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; /PREFFER longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; /AVOID以下是兩個縮進方法聲明的例子。前者是常規(guī)情形。后者若使用常規(guī)的縮進方式將會使第二行和第三行移得很靠右，所以代之以縮進8個空格。 /CONVENTIONAL INDENTATION someMethod(int anArg, Object anotherArg, Strin

41、g yetAnotherArg, Object andStillAnother) . /INDENT 8 SPACES TO AVOID VERY DEEP INDENTS private static synchronized horkingLongMethodName(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) . if語句的換行通常使用8個空格的規(guī)則，因為常規(guī)縮進(4個空格)會使語句體看起來比較費勁。比如：/DONT USE THIS INDENTATION if (conditi

42、on1 && condition2) | (condition3 && condition4) |!(condition5 && condition6) /BAD WRAPS doSomethingAboutIt(); /MAKE THIS LINE EASY TO MISS /USE THIS INDENTATION INSTEAD if (condition1 && condition2) | (condition3 && condition4) |!(condition5 && conditi

43、on6) doSomethingAboutIt(); /OR USE THIS if (condition1 && condition2) | (condition3 && condition4) |!(condition5 && condition6) doSomethingAboutIt(); 這里有三種可行的方法用于處理三元運算表達式： alpha = (aLongBooleanExpression) ? beta : gamma; alpha = (aLongBooleanExpression) ? beta : gamma; alpha

44、 = (aLongBooleanExpression) ? beta : gamma;5 注釋(Comments) Java程序有兩類注釋：Ø 實現(xiàn)注釋(implementation comments)Ø 文檔注釋(document comments)實現(xiàn)注釋使用/*.*/和/界定的注釋。文檔注釋(被稱為“doc comments”)是Java獨有的，并由/*.*/界定。文檔注釋可以通過javadoc工具轉換成HTML文件。實現(xiàn)注釋用以注釋代碼或者實現(xiàn)細節(jié)。文檔注釋從實現(xiàn)自由(implementation-free)的角度描述代碼的規(guī)范。它可以被那些手頭沒有源碼的開發(fā)人員讀

45、懂。注釋應被用來給出代碼的總括，并提供代碼自身沒有提供的附加信息。注釋應該僅包含與閱讀和理解程序有關的信息。例如，相應的包如何被建立或位于哪個目錄下之類的信息不應包括在注釋中。在注釋里，對設計決策中重要的或者不是顯而易見的地方進行說明是可以的，但應避免提供代碼中己清晰表達出來的重復信息。多余的注釋很容易過時。通常應避免那些代碼更新就可能過時的注釋。注意：頻繁的注釋有時反映出代碼的低質量。當你覺得被迫要加注釋的時候，考慮一下重寫代碼使其更清晰。注釋不應寫在用星號或其它字符畫出來的大框里。注釋不應包括諸如制表符和回退符之類的特殊字符。n 5.1 實現(xiàn)注釋的格式(Implementation Com

46、ment Formats)程序可以有4種實現(xiàn)注釋的風格：塊(block)、單行(single-line)、尾端(trailing)和行末(end-of-line)。5.1.1 塊注釋(Block Comments)塊注釋通常用于提供對文件，方法，數(shù)據(jù)結構和算法的描述。塊注釋被置于每個文件的開始處以及每個方法之前。它們也可以被用于其他地方，比如方法內部。在功能和方法內部的塊注釋應該和它們所描述的代碼具有一樣的縮進格式。塊注釋之首應該有一個空行，用于把塊注釋和代碼分割開來，比如： /* * Here is a block comment. */塊注釋可以以/*-開頭，這樣indent(1)就可以將

47、之識別為一個代碼塊的開始，而不會重排它。 /*- * Here is a block comment with some very special * formatting that I want indent(1) to ignore. * * one * two * three */注意：如果你不使用indent(1)，就不必在代碼中使用/*-，或為他人可能對你的代碼運行indent(1)作讓步。5.1.2 單行注釋(Single-Line Comments)短注釋可以顯示在一行內，并與其后的代碼具有一樣的縮進層級。如果一個注釋不能在一行內寫完，就該采用塊注釋(參見“塊注釋”)。單行注釋之前應該有一個空行。以下是一個Java代碼中單行注釋的例子： if (condition) /* Handle the condition. */ . 5.1.3 尾端注釋(Trailing Comments)極短的注釋可以與它們所要描述的代碼位于同一行，但是應該有足夠的空白來分開代碼和注釋。若有多個短注釋出現(xiàn)于大段代碼中，它們應該具有相同的縮進。以下是一