項目詳細設計說明書xxx模塊）擬制

日期

yyyy-mm-dd評審人

日期批準

日期簽發

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