軟件文檔寫作10開(kāi)發(fā)文檔2

6.4軟件概要設(shè)計(jì)文檔

概要設(shè)計(jì)階段的主要任務(wù)是把系統(tǒng)的功能需求分配給軟件結(jié)構(gòu)，形成軟件的系統(tǒng)結(jié)構(gòu)，并完成表達(dá)。目前，整個(gè)軟件界對(duì)軟件結(jié)構(gòu)的組成要素和描述還沒(méi)有形成統(tǒng)一的規(guī)范，主要還是依賴于設(shè)計(jì)者的知識(shí)、經(jīng)驗(yàn)和技巧。此外，由于人們對(duì)同一設(shè)計(jì)方法的理解和表達(dá)差別很大，所使用的符號(hào)體系、約定和流行的術(shù)語(yǔ)概念缺乏嚴(yán)格和一致性、系統(tǒng)性，沒(méi)有形成對(duì)軟件結(jié)構(gòu)整體設(shè)計(jì)的一般性指導(dǎo)。因此，研究和建立形式化、規(guī)范化的描述方法是軟件界的一項(xiàng)重要課題。我們前面曾經(jīng)介紹的“軟件視圖”表達(dá)方法及對(duì)軟件文檔風(fēng)格的影響，就是試圖在這個(gè)方面有所進(jìn)展。1回顧其中主要的表達(dá)類型有：1.模塊視圖類型——能為系統(tǒng)主要實(shí)現(xiàn)單元編制文檔服務(wù)；2.組件和連接器(C&C)視圖類型——能為系統(tǒng)執(zhí)行單元編制文檔服務(wù)；3.分配視圖類型——能為系統(tǒng)軟件與其開(kāi)發(fā)和執(zhí)行環(huán)境之間的關(guān)系編制文檔服務(wù)。我們已經(jīng)介紹的類型風(fēng)格主要有：分解風(fēng)格、使用風(fēng)格、泛化風(fēng)格、分層風(fēng)格、部署風(fēng)格、實(shí)現(xiàn)風(fēng)格和工作任務(wù)風(fēng)格等。這3種視圖類型代表著系統(tǒng)設(shè)計(jì)師在設(shè)計(jì)系統(tǒng)時(shí)必須考慮的3種視角：將系統(tǒng)看成實(shí)現(xiàn)單元、運(yùn)行時(shí)執(zhí)行單元、從軟件元素到環(huán)境結(jié)構(gòu)的映射。而文檔就是要記錄這些內(nèi)容。反映到概要設(shè)計(jì)具體的表現(xiàn)形式，主要是：結(jié)構(gòu)化設(shè)計(jì)表達(dá)、面向?qū)ο笤O(shè)計(jì)表達(dá)。21.結(jié)構(gòu)化表現(xiàn)形式

結(jié)構(gòu)化程序設(shè)計(jì)在數(shù)據(jù)類型和結(jié)構(gòu)化控制描述支持下，主程序和子過(guò)程按照一定的構(gòu)造邏輯分層布置，是主要的程序設(shè)計(jì)思想。在這樣的思想下，系統(tǒng)的結(jié)構(gòu)被映射為主程序和一系列具有調(diào)用關(guān)系的子過(guò)程的集合。這在程序設(shè)計(jì)語(yǔ)言中，直接與主程序和過(guò)程/函數(shù)的概念相對(duì)應(yīng)。更復(fù)雜的系統(tǒng)設(shè)計(jì)包含了庫(kù)、包、模塊、程序覆蓋等概念。常用的概要設(shè)計(jì)結(jié)構(gòu)化表現(xiàn)方法有：層次圖、HIPO圖、結(jié)構(gòu)圖等。如下圖是一個(gè)層次圖的例。字處理系統(tǒng)輸入輸出編輯存儲(chǔ)檢索格式化編目錄添加刪除插入修改合并列表3簡(jiǎn)單的層次圖缺乏追蹤性，而HIPO圖可以彌補(bǔ)此一缺點(diǎn)。實(shí)際上，HIPO圖是由H圖和IPO圖兩部分組成：H圖就是層次圖；和H圖每個(gè)方框相對(duì)應(yīng)的，應(yīng)該有一張IPO圖描述該方框代表的模塊的處理過(guò)程。如下圖，是一個(gè)帶編號(hào)的H圖的例，具有可追蹤性。字處理系統(tǒng)輸出2.0輸入1.0存儲(chǔ)4.0編輯3.0格式化6.0檢索5.0編目錄7.0刪除3.2添加3.1修改3.4插入3.3列表3.6合并3.5IPO圖使用的符號(hào)既少又簡(jiǎn)單，能夠方便的描述數(shù)據(jù)輸入、處理和輸出之間的關(guān)系。如下圖是一個(gè)主文檔更新的IPO例子。4程序名：模塊名：編制者：日期：頁(yè)號(hào)：輸入處理輸出舊的主文件事務(wù)文件1.檢驗(yàn)主記錄2.校驗(yàn)事務(wù)記錄3.更新主記錄有效的主記錄有效的事務(wù)記錄更新后的主記錄圖中，箭頭清楚的指出了數(shù)據(jù)通信的情況。Yourdon提出的結(jié)構(gòu)圖是進(jìn)行軟件結(jié)構(gòu)設(shè)計(jì)的另一個(gè)有力的表達(dá)方法。而且，結(jié)構(gòu)圖較之層次圖有更強(qiáng)的描述力。5下圖是結(jié)構(gòu)圖的一個(gè)例子：產(chǎn)生最佳解得到好輸入計(jì)算最佳解輸出結(jié)果讀輸入編輯輸入結(jié)果格式化顯示結(jié)果好輸入解好輸入解原始輸入原始輸入編輯結(jié)束解解的格式化格式化的解結(jié)構(gòu)圖還有一些附加的符號(hào)，用以表示模塊的選擇調(diào)用和循環(huán)調(diào)用。如下圖，左圖是選擇調(diào)用，右圖是循環(huán)調(diào)用。MAB判定為真時(shí)調(diào)用模塊A，否則調(diào)用模塊BMACB模塊M循環(huán)調(diào)用模塊A、B、C62.面向?qū)ο笤O(shè)計(jì)表現(xiàn)形式數(shù)據(jù)抽象和面向?qū)ο笤O(shè)計(jì)是在主程序和子過(guò)程設(shè)計(jì)基礎(chǔ)上建立和發(fā)展起來(lái)的重要的軟件描述方法。數(shù)據(jù)抽象是面向?qū)ο笤O(shè)計(jì)的理論基礎(chǔ)。類和對(duì)象是該描述方法的基礎(chǔ)粒度。與傳統(tǒng)軟件工程將設(shè)計(jì)描述基礎(chǔ)建立在模塊或包上不同，面向?qū)ο笤O(shè)計(jì)方法的描述將軟件的組成建立在類和對(duì)象的粒度上，極大的改變了軟件描述的特性，并一舉帶來(lái)軟件結(jié)構(gòu)的革命性變化。目前，面向?qū)ο蠓椒ㄒ呀?jīng)成為軟件設(shè)計(jì)的基礎(chǔ)和出發(fā)點(diǎn)。一些重要的軟件設(shè)計(jì)思想，如消息、組件、控件、部件等，都是在此基礎(chǔ)上提出來(lái)的，都可以從類和對(duì)象中找到蹤跡。面向?qū)ο笤O(shè)計(jì)文檔表達(dá)根據(jù)下圖結(jié)構(gòu)的表達(dá)，有多種方式，下面逐個(gè)介紹。7(1)面向?qū)ο笤O(shè)計(jì)(OOD)的4個(gè)部分

這4個(gè)部分是問(wèn)題域、人機(jī)交互部分、任務(wù)管理部分和數(shù)據(jù)管理部分。如下圖所示。主題層類及對(duì)象層結(jié)構(gòu)層屬性層問(wèn)題域部分人機(jī)交互部分任務(wù)管理部分?jǐn)?shù)據(jù)管理部分-問(wèn)題域部分：OOD根據(jù)需求分析中對(duì)問(wèn)題域的描述，針對(duì)實(shí)現(xiàn)要求進(jìn)行必要的整補(bǔ)和調(diào)整。其重點(diǎn)是：重用類設(shè)計(jì)、組合問(wèn)題域?qū)Ｓ妙?、調(diào)整繼承的支持級(jí)別、提供數(shù)據(jù)管理部分以及增加底層細(xì)節(jié)。-人機(jī)交互部分設(shè)計(jì)：突出人如何命令系統(tǒng)，及系統(tǒng)如何向用戶提交信息。尤其對(duì)非計(jì)算機(jī)專業(yè)用戶如何提交信息。-任務(wù)管理部分設(shè)計(jì)：設(shè)計(jì)策略要點(diǎn)是識(shí)別并設(shè)計(jì)任務(wù)，加上包含在每個(gè)任務(wù)中的服務(wù)。-設(shè)計(jì)管理部分設(shè)計(jì)：該部分主要是為了隔離數(shù)據(jù)管理方案對(duì)系統(tǒng)設(shè)計(jì)表達(dá)的影響。設(shè)計(jì)既包含數(shù)據(jù)存放方法的設(shè)計(jì)，也包含相應(yīng)服務(wù)的設(shè)計(jì)。8(2)概要設(shè)計(jì)OOD與OOA的表現(xiàn)形式有相似之處，但OOD需要針對(duì)實(shí)現(xiàn)的要求進(jìn)行必要的增補(bǔ)和調(diào)整。面向?qū)ο笙到y(tǒng)的一個(gè)典型的系統(tǒng)結(jié)構(gòu)是模型/視圖/控制器(MVC)框架結(jié)構(gòu)。其中，模型是指應(yīng)用中的對(duì)象，其操作獨(dú)立于用戶界面；視圖則管理用戶界面的輸出；控制器處理應(yīng)用的輸入。見(jiàn)下圖。視圖模型控制器系統(tǒng)結(jié)構(gòu)實(shí)際上是一些抽象的類的集合，提供了系統(tǒng)的最上層設(shè)計(jì)。定義這些抽象類的新的子類和把它們實(shí)例化，可以實(shí)現(xiàn)所要求的特定行為，借此可以構(gòu)造待開(kāi)發(fā)的系統(tǒng)。概要設(shè)計(jì)過(guò)程編檔就是記錄這一構(gòu)造過(guò)程和結(jié)果。9(3)概要設(shè)計(jì)技術(shù)的常用表示方法有繼承機(jī)制、聚集關(guān)系、對(duì)象關(guān)聯(lián)、注冊(cè)/觀察器、虛擬設(shè)備和代理結(jié)構(gòu)等多種表示方法。①繼承機(jī)制的表示通常將父類放在上面，將子類放在下面。如左圖AB父類子類派生繼承動(dòng)物家禽類寵物雞鴨鵝狗貓下圖是表示雞、鴨、貓、狗和動(dòng)物之間的繼承關(guān)系。10②聚集關(guān)系的表示若類B的定義將類A的對(duì)象作為數(shù)據(jù)成員，則B和A之間是一種聚集關(guān)系，其表示方法如右圖所示。汽車B輪胎A子午線輪胎③對(duì)象關(guān)聯(lián)的表示對(duì)象不是獨(dú)立存在的，總是要以一定形式與其它對(duì)象發(fā)生關(guān)系的。如一對(duì)一、一對(duì)多的單向關(guān)系。主要關(guān)聯(lián)方式分內(nèi)嵌關(guān)聯(lián)和外嵌關(guān)聯(lián)兩種。關(guān)聯(lián)源對(duì)象關(guān)聯(lián)指針被關(guān)聯(lián)對(duì)象屬性Next關(guān)聯(lián)對(duì)象指針屬性Next關(guān)聯(lián)對(duì)象指針屬性Next關(guān)聯(lián)對(duì)象指針被關(guān)聯(lián)對(duì)象被關(guān)聯(lián)對(duì)象圖：內(nèi)嵌關(guān)聯(lián)結(jié)構(gòu)表示A類對(duì)象：A1A類對(duì)象：A1A類對(duì)象：A2B類對(duì)象：B1B類對(duì)象：B2B類對(duì)象：B3AB關(guān)聯(lián)類B類AB類對(duì)象關(guān)聯(lián)表A類對(duì)象標(biāo)識(shí)B類對(duì)象標(biāo)識(shí)關(guān)聯(lián)對(duì)象A1 B1 AB1A1 B2 AB2A2 B1 AB3… … …圖：外嵌關(guān)聯(lián)結(jié)構(gòu)表示11④注冊(cè)/觀察器的表示一種將新的信息一對(duì)一的迅速傳送或通知給相關(guān)對(duì)象的對(duì)象協(xié)作機(jī)制。特別在分布式環(huán)境中，對(duì)象通信代價(jià)很高時(shí)，這是一種高效的手段，在網(wǎng)絡(luò)軟件設(shè)計(jì)時(shí)常用。見(jiàn)下圖例。生產(chǎn)者CollectionClientAttach()Detach()GetData()Generator()Notify()客戶生產(chǎn)者*Gen客戶()～客戶()Update()SetGen()……Notify()……ClientUpdate()…GenAttach()GenDetach()1..n12⑤虛擬設(shè)備的表示虛擬設(shè)備是操作系統(tǒng)的一個(gè)重要概念。使用這種概念，可以為在不同設(shè)備上實(shí)現(xiàn)相同功能，或以相同操作接口訪問(wèn)不同設(shè)備提供可能和方便。如圖ApplicationCanvasDraw()Line()Circle()Rectangle()TextOut()…DrawSpaceDraw()Line()Circle()Rectangle()TextOut()…PrinterDrawSpaceDraw()Line()Circle()Rectangle()TextOut()…PrinterPrewDrawSpaceDraw()Line()Circle()Rectangle()TextOut()…ScreenWinDrawSpaceDraw()Line()Circle()Rectangle()TextOut()…OtherGDI13⑥代理結(jié)構(gòu)的表示代理是一種在應(yīng)用和被訪問(wèn)對(duì)象之間建立的橋梁或關(guān)口。通過(guò)代理的虛擬作用，達(dá)到控制對(duì)象訪問(wèn)的目的。代理具有的作用或特性可以包括間接性、委托性、臨時(shí)替代性、虛擬性、安全性/保護(hù)性、遠(yuǎn)程性和多源性。下圖是代理模式的實(shí)現(xiàn)結(jié)構(gòu)表示的例。ApplicationObjectService()…ActualObjectService()…Object*anObjectService()…ProxyanObjectReturnanObjectService()14網(wǎng)絡(luò)代理連接的表示例子：應(yīng)用代理遠(yuǎn)程對(duì)象多源代理連接的例子應(yīng)用代理問(wèn)題求解對(duì)象1對(duì)象n對(duì)象2……連接連接連接連接156.5軟件詳細(xì)設(shè)計(jì)文檔

詳細(xì)設(shè)計(jì)在概要設(shè)計(jì)之后，其工作重點(diǎn)是考慮實(shí)現(xiàn)各個(gè)模塊的規(guī)定功能，表達(dá)的是模塊內(nèi)部的邏輯關(guān)系、數(shù)據(jù)結(jié)構(gòu)和模塊接口細(xì)節(jié)等，表達(dá)的方法主要有程序流程圖、N-S圖、PAD圖、PDL語(yǔ)言以及判定表、樹(shù)等。①程序流程圖程序流程圖也稱程序框圖，是一種獨(dú)立于任何程序設(shè)計(jì)語(yǔ)言的表達(dá)工具，因其直觀、清晰，易學(xué)、易用，而深受歡迎。然而，由于其存在致命的缺點(diǎn)——可以隨意轉(zhuǎn)向的箭頭，使得設(shè)計(jì)難以規(guī)范、質(zhì)量難以保證。目前，國(guó)際標(biāo)準(zhǔn)化機(jī)構(gòu)已經(jīng)不再推薦使用。程序流程圖主要由5種基本的控制結(jié)構(gòu)構(gòu)成，圖見(jiàn)下頁(yè)。16(1)順序結(jié)構(gòu)(sequentialstructure)(2)選擇結(jié)構(gòu)(selectivestructure)ABPBAFT(3)先判定型循環(huán)結(jié)構(gòu)(while-loopstructure)(4)后判定型循環(huán)結(jié)構(gòu)(until-loopstructure)TPSFFSTP(5)多情況選擇(casestructure)TA1FP=1TA2FP=2…TAnFP=n程序流程圖(ProgramFlowChart)的5種基本控制結(jié)構(gòu)：17順序ABPFTAB選擇PFTBDo-WhilePSWhile型循環(huán)Do-UntilPSUntil型循環(huán)Case型選擇P12nA1A2An子過(guò)程調(diào)用A②N-S圖：Nassi&Shneiderman1973年提出，又稱為盒圖(BoxDiagram)。Chapin1974年作擴(kuò)充，故也稱為Chapincharts。N-S圖規(guī)定了6種圖形構(gòu)件。18x4TFDo-Untilx5ighfkx1TFbDo-Untilx6ajx21cDo-Whilex323dek:N-S圖的例：19AB順序WhilePSUntilPS循環(huán)PABTHENELSE選擇P=A1A2Case型選擇An12n…陳述索引def定義③PAD圖(ProblemAnalysisDiagram,問(wèn)題分析圖)：

日立公司，1973年提出。為ISO所極力推薦。也有5種基本控制結(jié)構(gòu)。20開(kāi)始結(jié)束aj

Until

x5i

Until

x6bx1kfx4ghdefkx2de123

While

x3c例：N-S圖的例轉(zhuǎn)換到PAD圖。21PROCEDUREspell_checkISBEGIN

SplitdocumentintosinglewordsLookupwordsindictionaryDisplaywordswhicharenotindictionaryCreateanewdictionaryENDspell_checkExternalstatementsInternalstatements④PDL(ProgramDesi