軟件的詳細(xì)設(shè)計(jì)的說明書

項(xiàng)目詳細(xì)設(shè)計(jì)說明書xxx模塊）擬制

日期

yyyy-mm-dd評(píng)審人

日期批準(zhǔn)

日期簽發(fā)

日期實(shí)用標(biāo)準(zhǔn)文案文檔修訂記錄版本 完成人 修改內(nèi)容 審核 批準(zhǔn) 時(shí)間V0.00 創(chuàng)建文檔精彩文檔實(shí)用標(biāo)準(zhǔn)文案目 錄簡(jiǎn)介61.1.編寫目的..............................................................................................................................................61.2.適用范圍..............................................................................................................................................61.2.1.軟件名稱.................................................................................................................................61.2.2.軟件功能.................................................................................................................................61.2.3.軟件應(yīng)用.................................................................................................................................61.3.定義及關(guān)鍵詞.....................................................................................................................................61.4.參考資料..............................................................................................................................................72.子模塊1設(shè)計(jì)描述..........................................................................................................................................82.1.類xxx的設(shè)計(jì).....................................................................................................................................82.1.1.簡(jiǎn)介.........................................................................................................................................82.1.2.類圖.........................................................................................................................................82.1.3.狀態(tài)設(shè)計(jì)（可選）................................................................................................................82.1.4.屬性.........................................................................................................................................82.1.5.方法.........................................................................................................................................93.數(shù)據(jù)庫(kù)詳細(xì)設(shè)計(jì)（可選）..........................................................................................................................133.1.存儲(chǔ)過程#/觸發(fā)器#的名稱..........................................................................................................134.錯(cuò)誤處理........................................................................................................................................................144.1.系統(tǒng)錯(cuò)誤...........................................................................................................................................144.2.接口錯(cuò)誤...........................................................................................................................................144.3.協(xié)議錯(cuò)誤...........................................................................................................................................14精彩文檔實(shí)用標(biāo)準(zhǔn)文案精彩文檔實(shí)用標(biāo)準(zhǔn)文案表目錄表1. 關(guān)鍵詞 6表2. 類XXX的屬性 8表3. 方法描述 xxx-function 9圖目錄圖1 類圖xxx-class 8圖2 流程圖xxx-function 10精彩文檔實(shí)用標(biāo)準(zhǔn)文案簡(jiǎn)介1.1.編寫目的這部分要描述文檔的目的，并指明文檔的讀者。1.2.適用范圍軟件名稱軟件功能解釋軟件產(chǎn)品將完成或不完成的功能軟件應(yīng)用描述軟件的應(yīng)用領(lǐng)域1.3.定義及關(guān)鍵詞表1.關(guān)鍵詞關(guān)鍵詞 英文全名 中文解釋精彩文檔實(shí)用標(biāo)準(zhǔn)文案1.4.參考資料[1]精彩文檔實(shí)用標(biāo)準(zhǔn)文案子模塊1設(shè)計(jì)描述2.1.類xxx的設(shè)計(jì)簡(jiǎn)介如果在概要設(shè)計(jì)中未說明，則在此詳細(xì)描述類的職責(zé)和功能，可使用順序圖、協(xié)作圖、狀態(tài)圖來詳細(xì)描述。必要時(shí)，可描述本類與相關(guān)類之間的靜態(tài)動(dòng)態(tài)關(guān)系。類圖圖1類圖xxx-class狀態(tài)設(shè)計(jì)（可選）可以用狀態(tài)圖來描述類的狀態(tài)信息。屬性可先定義相關(guān)的數(shù)據(jù)結(jié)構(gòu)，再對(duì)屬性進(jìn)行描述。也可以不使用表格、而使用偽代碼格式。表2.類XXX的屬性可見性 屬性名稱 類型 說明（對(duì)屬性的簡(jiǎn)短描述）PrivatePublicProtected精彩文檔實(shí)用標(biāo)準(zhǔn)文案方法方法xxx方法描述Java的函數(shù)頭注釋采用 JavaDoc 自動(dòng)生成的格式：/***@functions 增刪改查 XXX*@param Stringname 名字*@return true 如果不為空則返回真， false 如果為空返回假*@throws 無*/C++使用以下格式：表3.方法描述xxx-function函數(shù)原型 方法的聲明，包含可見性功能描述 描述本方法的功能被調(diào)函數(shù) 被本函數(shù)調(diào)用的函數(shù)清單（非系統(tǒng)函數(shù)）主調(diào)函數(shù) 調(diào)用本函數(shù)的函數(shù)清單（非系統(tǒng)函數(shù)） ,可選輸入?yún)?shù) 描述每個(gè)輸入?yún)?shù)的含義、內(nèi)存管理原則（誰分配、誰釋放）輸出參數(shù) 描述每個(gè)輸出參數(shù)的含義、內(nèi)存管理原則（誰分配、誰釋放）返回值 描述返回值的含義拋出異常 描述可能拋出的異常精彩文檔實(shí)用標(biāo)準(zhǔn)文案實(shí)現(xiàn)描述（使用偽代碼、流程圖等來描述本方法的詳細(xì)實(shí)現(xiàn)。這部分是詳細(xì)設(shè)計(jì)的重點(diǎn)?？梢栽陂_發(fā)工具中編寫后再將文件嵌入到文檔中。 偽代碼請(qǐng)直接寫成注釋格式， 減少編碼階段的注釋工作量）initial()getValue()no yesvalue>1?NewActivity NewActivity23圖2流程圖xxx-functionvoidTestTask::iMapTaskCmdRecv(CmdMSG*CmdMsg){_US command=CmdMsg->CmdCode;生成應(yīng)答數(shù)據(jù)幀空間精彩文檔實(shí)用標(biāo)準(zhǔn)文案獲得任務(wù)的IDSwitch(command){case0x01:填寫對(duì)應(yīng)的業(yè)務(wù)字段和數(shù)據(jù)break;case0x02:填寫對(duì)應(yīng)的業(yè)務(wù)字段和數(shù)據(jù)break;default:break;}發(fā)送應(yīng)答數(shù)據(jù)幀設(shè)置任務(wù)狀態(tài)為TASK_STATE_WAITNEXT}方法xxx方法描述精彩文檔實(shí)用標(biāo)準(zhǔn)文案精彩文檔實(shí)用標(biāo)準(zhǔn)文案數(shù)據(jù)庫(kù)詳細(xì)設(shè)計(jì)（可選）描述存儲(chǔ)過程、觸發(fā)器等的詳細(xì)實(shí)現(xiàn)。3.1.存儲(chǔ)過程#/觸發(fā)器#