實(shí)用軟件工程課件第8章

實(shí)用軟件工程----IT企業(yè)軟件的開(kāi)發(fā)與管理趙池龍zhaochilong@

第8章軟件實(shí)現(xiàn)本章導(dǎo)讀：從宏觀上講，軟件實(shí)現(xiàn)包括詳細(xì)設(shè)計(jì)、編程實(shí)現(xiàn)、單元測(cè)試和集成測(cè)試。從微觀上講，軟件實(shí)現(xiàn)是指編程和單元測(cè)試。本章只講編程實(shí)現(xiàn)方法，包括編碼風(fēng)格、界面定義、幫助信息，以及用戶指南書(shū)寫(xiě)的參考指南。要求理解：編碼風(fēng)格、界面定義、幫助和提示信息要求掌握：

1）《用戶使用手冊(cè)》的編寫(xiě)方法

2）《用戶安裝手冊(cè)》的編寫(xiě)方法

8.1軟件實(shí)現(xiàn)方法軟件實(shí)現(xiàn)的輸入是《詳細(xì)設(shè)計(jì)說(shuō)明書(shū)》，輸出是源程序、目標(biāo)程序及用戶指南。根據(jù)“五個(gè)面向理論”，編程實(shí)現(xiàn)的主要方法是“面向?qū)ο髮?shí)現(xiàn)”。因?yàn)楝F(xiàn)在流行的編程語(yǔ)言，基本上都是面向?qū)ο蟮恼Z(yǔ)言?！懊嫦?qū)ο髮?shí)現(xiàn)”的目標(biāo)是：按照《詳細(xì)設(shè)計(jì)說(shuō)明書(shū)》的要求，從軟件公司的函數(shù)庫(kù)、類庫(kù)、構(gòu)件庫(kù)中挑選有關(guān)的零部件，遵照軟件公司的程序設(shè)計(jì)規(guī)范，用面向?qū)ο蟮恼Z(yǔ)言，通過(guò)穿針引線的方法，將這些零部件組裝起來(lái)，分別實(shí)現(xiàn)各模塊的功能，從而實(shí)現(xiàn)目標(biāo)系統(tǒng)的功能、性能、接口、界面等要求。軟件實(shí)現(xiàn)方法

1．新增函數(shù)的實(shí)現(xiàn)及函數(shù)庫(kù)的管理

2．新增存儲(chǔ)過(guò)程的實(shí)現(xiàn)及存儲(chǔ)過(guò)程庫(kù)的管理

3．新增類的實(shí)現(xiàn)及類庫(kù)的管理

4．新增構(gòu)件的實(shí)現(xiàn)及構(gòu)件庫(kù)的管理

5．新增中間件的實(shí)現(xiàn)及中間件的管理

6．部件組裝

7．程序設(shè)計(jì)風(fēng)格與編程規(guī)范

(1).程序設(shè)計(jì)風(fēng)格的內(nèi)容包括：規(guī)范化的程序內(nèi)部文檔、數(shù)據(jù)結(jié)構(gòu)的詳細(xì)說(shuō)明、清晰的語(yǔ)句結(jié)構(gòu)、遵守某一編程規(guī)范。

(2).編程規(guī)范的內(nèi)容包括：命名規(guī)范、界面規(guī)范、提示及幫助信息規(guī)范、熱鍵定義等。4.2源程序設(shè)計(jì)風(fēng)格良好的程序設(shè)計(jì)風(fēng)格，能使程序員進(jìn)行“無(wú)私程序設(shè)計(jì)”，避免程序員與其所產(chǎn)生的代碼之間的關(guān)系過(guò)于密切，提高程序代碼的規(guī)范化程度，使程序代碼易讀、易懂、易修改，實(shí)現(xiàn)程序員之間相互進(jìn)行程序測(cè)試和維護(hù)的目的。程序設(shè)計(jì)要求：（1）依照所確定的規(guī)范進(jìn)行程序設(shè)計(jì)。（2）模塊本身要高內(nèi)聚，模塊之間要低耦合。（3）每個(gè)程序模塊的行數(shù)不做規(guī)定。對(duì)于程序模塊中相對(duì)獨(dú)立性較強(qiáng)的程序塊，提煉成為一個(gè)函數(shù)或構(gòu)件。（4）盡量為程序塊加上明確的注釋。對(duì)于較復(fù)雜的程序或算法需要有注釋文件，并在程序中注明注釋文件名，在注釋文件中注明程序名。4.3屏幕界面設(shè)計(jì)屏幕界面上看得見(jiàn)的窗口、畫(huà)面、圖像、按鈕等對(duì)象，在設(shè)計(jì)與實(shí)現(xiàn)中，統(tǒng)稱為“控件”。構(gòu)件分為可視構(gòu)件和非可視構(gòu)件兩種，控件是一種可視構(gòu)件，它是構(gòu)件的一種表現(xiàn)形式。控件的有機(jī)排列和組合，就構(gòu)成了用戶需求的各種屏幕界面。屏幕界面設(shè)計(jì)的內(nèi)容包括：(1)控件級(jí)設(shè)計(jì);(2)窗口級(jí)定義;(3)系統(tǒng)級(jí)定義。屏幕界面設(shè)計(jì)遵從的原則是：界面簡(jiǎn)潔樸素，控件擺放整齊，顏色風(fēng)格統(tǒng)一，照顧客戶習(xí)慣。4.3.1控件級(jí)定義這里講的控件，是指屏幕界面上的控件，它是屏幕窗口中的基本元素，是構(gòu)件的一種表現(xiàn)形式。控件1：按鈕（Button）屬性：Height=92，Width依具體情況而定；按鈕在窗口右下方或右方排列，當(dāng)控件中包含按鈕時(shí)，按鈕不應(yīng)和控件外的按鈕在同一方向上排列?？丶?：按鈕（Button）控件2：分組框（GroupBox）控件3：?jiǎn)涡芯庉嬈?、下拉列表框、圖形下拉列表框、數(shù)字轉(zhuǎn)盤(pán)控件4：圖表（Graph）控件5：復(fù)選框、單選鈕控件6：圖片（Picture）控件7：標(biāo)簽（Tab）4.3.2窗口級(jí)定義窗口級(jí)定義包括：

(1)系統(tǒng)主窗口;(2)基本參數(shù)（又稱代碼或數(shù)據(jù)字典）維護(hù)窗口;(3)錄入查詢修改窗口;(4)統(tǒng)計(jì)窗口;(5)對(duì)話框窗口等等。在面向?qū)ο蟮木幊陶Z(yǔ)言中，窗口定義是一件較簡(jiǎn)單的事情。(1)．系統(tǒng)主窗口定義(2)．基本參數(shù)維護(hù)窗口定義(3)．錄入/查詢/修改窗口定義錄入/查詢/修改窗口定義（1）選中記錄：移動(dòng)鼠標(biāo)到該條記錄上，并單擊它。（2）瀏覽記錄：用鼠標(biāo)拖動(dòng)滾動(dòng)條，這樣可以看到更多的參數(shù)。（3）增加記錄：按下“插入”按鈕，在左邊的數(shù)據(jù)窗口中將會(huì)增加一條空白記錄。按下“保存”按鈕，就會(huì)將它存入數(shù)據(jù)庫(kù)中。（4）刪除記錄：選中將要?jiǎng)h除的記錄，按下“刪除”按鈕。按下“保存”按鈕，就會(huì)從數(shù)據(jù)庫(kù)中刪除該記錄。（5）修改記錄：選中需要修改的記錄，就可以修改。（6）放棄修改：對(duì)數(shù)據(jù)進(jìn)行了改動(dòng)，允許放棄改動(dòng)。辦法是按下右邊的“查詢”按鈕。（7）打印記錄：按下“打印”按鈕，就得到所需的報(bào)表。

(4)．統(tǒng)計(jì)窗口定義統(tǒng)計(jì)窗口定義(5)．對(duì)話框窗口定義4.3.3系統(tǒng)級(jí)定義(1)．系統(tǒng)結(jié)構(gòu)圖定義用彩色示意圖，形象地表示該系統(tǒng)的總體結(jié)構(gòu)。(2)．起始畫(huà)面定義用于顯示系統(tǒng)的名稱和版權(quán)人等信息。(3)．登錄定義用戶錄入名稱和口令，登錄等待過(guò)程需加入動(dòng)畫(huà)。(4)．菜單定義同一層菜單項(xiàng)之間，功能不同者用“橫線”隔開(kāi)；主菜單項(xiàng)名稱用“兩個(gè)字符”表達(dá)；子系統(tǒng)功能相同的菜單項(xiàng)必須用同一名稱。(5)．快捷鍵定義4.4幫

助

信

息幫助信息與用戶指南有所不同。前者是聯(lián)機(jī)在線動(dòng)態(tài)幫助，后者是脫機(jī)靜態(tài)指導(dǎo)。聯(lián)機(jī)動(dòng)態(tài)幫助與程序運(yùn)行之間，存在動(dòng)態(tài)對(duì)應(yīng)關(guān)系。脫機(jī)靜態(tài)幫助，是一種宏觀靜態(tài)說(shuō)明。幫助信息又分為：在線幫助和提示信息兩部分，此處專門介紹幫助信息的實(shí)現(xiàn)方法。4.4.1在線幫助程序代碼與在線幫助的關(guān)系采用間接調(diào)用方式處理。在幫助菜單或按鈕中，先調(diào)用幫助關(guān)鍵字，再根據(jù)關(guān)鍵字查找?guī)椭黝}。這樣可以使程序代碼開(kāi)發(fā)和幫助書(shū)寫(xiě)工作分離，便于開(kāi)發(fā)過(guò)程中整體工作的協(xié)調(diào)安排。(1)．在線幫助的使用規(guī)定所有的業(yè)務(wù)功能（如錄入、修改、查詢、制單處理、總賬處理、明細(xì)賬處理）或者較復(fù)雜的非業(yè)務(wù)功能（如任意匯總查詢、數(shù)據(jù)通信和傳輸）中都要提供在線幫助；使用按鈕操作的窗口，在線幫助使用按鈕；使用菜單操作的窗口，在線幫助使用菜單；對(duì)于查詢功能，查詢結(jié)果形成前的響應(yīng)窗口應(yīng)提供在線幫助。

在線幫助(2)．在線幫助的處理過(guò)程在所有需要幫助的地方，調(diào)用一個(gè)自定義的公用函數(shù)，由該函數(shù)負(fù)責(zé)打開(kāi)在線幫助。公用函數(shù)的格式如下：

GifHelp(String

psHelpId)

參數(shù)psHelpId

為幫助關(guān)鍵字。(3)．幫助關(guān)鍵字的構(gòu)造規(guī)范幫助關(guān)鍵字

=系統(tǒng)編號(hào)（2位）+|+對(duì)象名字(不定位)+|+語(yǔ)義序號(hào)(4)．在線幫助函數(shù)的調(diào)用方法及規(guī)定

psHelpId按照上述規(guī)定的規(guī)范形成。各程序員都要形成一個(gè)積累幫助的文件，文件名規(guī)定為Help+程序員名字縮寫(xiě)，每調(diào)用一次，都要向該文件中加入一行信息，以登記調(diào)用情況，文件格式的規(guī)定，如表8-3所示。表8-3幫助文件的格式

子系統(tǒng)模塊幫助關(guān)鍵字在線幫助(5)．幫助關(guān)鍵字與幫助主題的對(duì)應(yīng)關(guān)系為了保證程序中所調(diào)用的幫助關(guān)鍵字能夠同幫助文件中幫助主題完全對(duì)應(yīng)，特定義一個(gè)保存這種對(duì)應(yīng)關(guān)系的文件，該文件稱為對(duì)應(yīng)關(guān)系文件，它作為一個(gè)客戶端的配置文件存在，不在數(shù)據(jù)庫(kù)中單獨(dú)列表。

配置文件名：HLPTOPIC.INI

格式：

[子系統(tǒng)代碼]

HelpId=HelpTopic，HelpFile

例如：

[ZW]

zw|w_kmzd|kmsr=幫助主題，幫助文件

zw|w_pzcl|pzsr=幫助主題，幫助文件4.4.2提示信息1．提示信息的分類可將系統(tǒng)中所有提示信息分為4類：（1）引導(dǎo)性提示信息：該類提示信息一般在需要用戶干預(yù)時(shí)出現(xiàn)，要求用戶決定下一步的操作。如在退出時(shí)提示“修改的數(shù)據(jù)尚未存盤(pán)，存盤(pán)否？”。（2）錯(cuò)誤性提示信息：該類提示信息一般在軟件運(yùn)行出錯(cuò)時(shí)出現(xiàn)，告訴用戶軟件遇到了問(wèn)題。如“系統(tǒng)運(yùn)行出現(xiàn)故障，請(qǐng)與系統(tǒng)管理員聯(lián)系！”。（3）狀態(tài)性提示信息：該類提示信息一般在軟件處于“忙”狀態(tài)下提示，告訴用戶軟件正在進(jìn)行什么操作，讓用戶耐心等待。如“正在進(jìn)行數(shù)據(jù)傳輸，請(qǐng)稍待…”。（4）位置性提示信息：該類提示信息一般根據(jù)鼠標(biāo)的位置進(jìn)行提示，告訴用戶鼠標(biāo)正指向什么功能。如“報(bào)表打印”。提示信息2．提示信息的提示方法對(duì)于所有提示信息，可使用函數(shù)gsShowMessage(psMessId，psErrMess)，其中psMessId為提示信息的ID號(hào)，psErrMess為根據(jù)系統(tǒng)獲得的錯(cuò)誤信息，該參數(shù)只對(duì)錯(cuò)誤性提示信息有效。（1）對(duì)于引導(dǎo)性提示信息，使用MessageBox進(jìn)行提示。（2）對(duì)于錯(cuò)誤性提示信息，顯示時(shí)只顯示信息表中提供的信息，提供詳細(xì)按鈕，執(zhí)行時(shí)將詳細(xì)的錯(cuò)誤信息顯示出來(lái)。（3）對(duì)于狀態(tài)性提示信息，顯示一個(gè)固定窗口，同時(shí)提供一個(gè)函數(shù)gsCloseMess()，對(duì)于該類提示信息，在執(zhí)行完畢后，執(zhí)行函數(shù)將提示窗口關(guān)閉。（4）位置性提示信息顯示在狀態(tài)提示欄中。提示信息3．信息序號(hào)的編碼規(guī)則及使用時(shí)應(yīng)做的工作

(1).信息序號(hào)的規(guī)則如下：信息序號(hào)=信息類別（兩位）+信息代號(hào)（八位）(2).“信息類別”表示為以下信息中的一種：（1）.LE引導(dǎo)性信息（2）.ER錯(cuò)誤性信息（3）.ST狀態(tài)性信息（4）.PO位置性信息(3).“信息級(jí)別”僅對(duì)ER有效，級(jí)別在最后統(tǒng)一編排。(4).“提問(wèn)方式”僅對(duì)LE有效，表示如何提示用戶，以便于用戶回答：YesNo(是否)；YesNoCancel(是否取消)；OkCancel(確認(rèn)取消)；Ok(確認(rèn))。提示信息4．提示信息的時(shí)機(jī)及內(nèi)容編寫(xiě)規(guī)定（1）引導(dǎo)性提示主要是引導(dǎo)用戶進(jìn)行下一步操作，一般出現(xiàn)的機(jī)會(huì)比較多，如“修改的數(shù)據(jù)未存盤(pán)，存盤(pán)否？”。（2）錯(cuò)誤性提示在測(cè)試比較好的情況下應(yīng)極少出現(xiàn)，它出現(xiàn)的原因不外乎兩種：一種為測(cè)試不夠；另一種可能為數(shù)據(jù)出現(xiàn)錯(cuò)誤，如服務(wù)器運(yùn)行異常等。對(duì)于這種情況一定要將錯(cuò)誤原因詳盡提示出來(lái)，由程序員在新的版本中改正錯(cuò)誤，或維護(hù)人員根據(jù)錯(cuò)誤原因解決問(wèn)題。（3）狀態(tài)性提示要明確簡(jiǎn)單，讓用戶確實(shí)了解系統(tǒng)目前正在“忙”什么。（4）要將位置性提示準(zhǔn)確顯示在狀態(tài)提示欄中。提示信息5．熱鍵定義及使用規(guī)范對(duì)于各種對(duì)象（如菜單、按鈕等）的熱鍵，在各種對(duì)象的介紹中已經(jīng)規(guī)定，在此不再做重復(fù)規(guī)定，這里只規(guī)定整個(gè)系統(tǒng)的熱鍵，如表8-5所示。

4.4.3其他規(guī)定（1）對(duì)于數(shù)字型（除Integer型）列，從表中取出后，必需進(jìn)行四舍五入處理。（2）使用通配符的地方，一律使用“？”表示。（3）在退出時(shí)，檢查數(shù)據(jù)窗口中的數(shù)據(jù)是否做過(guò)改動(dòng)，如做過(guò)改動(dòng)，應(yīng)提示用戶是否存盤(pán)。（4）在存盤(pán)之前，應(yīng)檢查數(shù)據(jù)窗口中各項(xiàng)數(shù)據(jù)的正確性，如有不符合條件的項(xiàng)，應(yīng)提示，改正后再行存盤(pán)，提示的內(nèi)容應(yīng)為“錯(cuò)誤信息”+“改正方法”。（5）對(duì)于日期型數(shù)據(jù)的顯示及輸入格式，規(guī)定為yyyy.mm.dd，不得使用其他任何格式。（6）每行數(shù)據(jù)輸入、刪除或修改后，要能夠及時(shí)提交。（7）在輸入某一項(xiàng)數(shù)據(jù)時(shí)，如果該項(xiàng)不在可視屏內(nèi)，則應(yīng)將該項(xiàng)移動(dòng)到可視屏內(nèi)。其他規(guī)定（8）可以在事件中調(diào)用函數(shù)，但一般不在函數(shù)中觸發(fā)事件。函數(shù)體內(nèi)的語(yǔ)句出錯(cuò)時(shí)，要返回錯(cuò)誤代碼（如1表示成功，－1表示失敗）等。（9）規(guī)定：事件的觸發(fā)應(yīng)不超過(guò)三級(jí)，視圖的連續(xù)層數(shù)應(yīng)不超過(guò)三層。（10）在數(shù)據(jù)更新中，動(dòng)態(tài)SQL語(yǔ)句或嵌入式SQL語(yǔ)句執(zhí)行后都要進(jìn)行判斷，根據(jù)執(zhí)行結(jié)果來(lái)決定下一步操作。（11）在某一子系統(tǒng)的主菜單下打開(kāi)一窗口時(shí)，如果該窗口是Main（主）窗口，則以O(shè)penSheet()打開(kāi)。（12）規(guī)定全程變量表，是各系統(tǒng)實(shí)現(xiàn)前要做的一項(xiàng)重要的工作。至于各子系統(tǒng)所使用的全程變量，則要待各子系統(tǒng)設(shè)計(jì)完成后，由高級(jí)程序員根據(jù)情況定義，但通用全程變量各子系統(tǒng)都要使用。4.5軟件實(shí)現(xiàn)文檔1．實(shí)現(xiàn)文檔的組成軟件實(shí)現(xiàn)文檔由源程序清單和用戶指南組成。由于面向?qū)ο蟮恼Z(yǔ)言與面向過(guò)程的語(yǔ)言有所不同，所以完整的源程序清單有時(shí)打印不出來(lái)，往往只能打印出部分源程序清單。一般的做法是：不打印出源程序清單，只保留其電子版本。用戶指南主要包括《用戶使用手冊(cè)》和《用戶安裝手冊(cè)》。在特殊情況下，例如，數(shù)據(jù)庫(kù)服務(wù)器上的存儲(chǔ)管理、數(shù)據(jù)維護(hù)、數(shù)據(jù)備份、數(shù)據(jù)傳輸?shù)葐?wèn)題較復(fù)雜時(shí)，在用戶指南中還要增加《系統(tǒng)管理員手冊(cè)》的內(nèi)容。軟件實(shí)現(xiàn)文檔2．用戶指南的編寫(xiě)要求（1）統(tǒng)一采用編寫(xiě)工具Word進(jìn)行編寫(xiě)。（2）用統(tǒng)一的風(fēng)格和確定的方法，描述產(chǎn)品提供的所有功能。描述之后的功能，應(yīng)該具有如下特點(diǎn)：對(duì)于每一項(xiàng)功能的描述應(yīng)該完整。（3）術(shù)語(yǔ)部分包括系統(tǒng)術(shù)語(yǔ)和基本概念。系統(tǒng)術(shù)語(yǔ)在整個(gè)系統(tǒng)的含義是統(tǒng)一的，放在前言部分描述?；靖拍钤诟饔嘘P(guān)章節(jié)進(jìn)行描述。（4）語(yǔ)言要簡(jiǎn)潔明快，表達(dá)準(zhǔn)確。一句話不要太長(zhǎng)，中間可以斷句幾次。（5）指南格式應(yīng)統(tǒng)一。軟件實(shí)現(xiàn)文檔3．用戶指南的排版建議

（1）.2人以上合作編寫(xiě)，一定要有一人負(fù)責(zé)統(tǒng)稿。

(2）.交稿前一定要最后一次仔細(xì)審讀。（3）.圖以章為序，如圖5.1或圖5-1（半字線連接章號(hào)和圖號(hào)）。

(4）.表以章為序，如表3.1或表3-2。（5）.命令格式。操作步驟中使用的命令按鈕、菜單命令項(xiàng)、標(biāo)簽項(xiàng)等名稱用【】界定。如：打開(kāi)【開(kāi)始】菜單選擇【程序】項(xiàng)……

（6）.例題格式。例題以章為序，并用【】界定。如【例3.5】或【例3-5】。軟件實(shí)現(xiàn)文檔4．用戶指南的編寫(xiě)原則（1）列出應(yīng)編制文檔的目錄。（2）提示編制文檔應(yīng)參考的標(biāo)準(zhǔn)。（3）指定文檔管理員。（4）提供編制文檔所需要的條件，落實(shí)文檔編寫(xiě)人員、主管和所需經(jīng)費(fèi)以及編制工具等。（5）明確保證文檔質(zhì)量的方法，為了確保文檔內(nèi)容的正確性、合理性，應(yīng)采取一定的措施，如評(píng)審、審稿、鑒定等。（6）繪制進(jìn)度表，以圖表形式列出各階段應(yīng)產(chǎn)生的文檔、編制人員、編制主管、編制日期、完成日期、評(píng)審