DOCPROPERTY"userfullname"某企業全稱DOCPROPERTY"proposalname"詳細設計說明書企業全稱TIME\@"yyyy'年'M'月'd'日'"2021年7月1日 DOCPROPERTY"proposalname"詳細設計說明書 第詳細設計說明書文檔副標題文檔版本0.1文檔日期文檔狀態草案作者文檔變更版本修訂日期修訂人描述文檔送呈姓名目的

目錄TOC\o"1-3"\h\z1 引言 41.1 編寫目的 41.2 范圍 41.3 術語 41.4 參考資料 51.5 約定 52 模塊設計 62.1 模塊1 62.1.1 描述 62.1.2 用戶界面 62.1.3 類設計 62.1.4 處理流程 72.1.5 關聯模塊 72.1.6 其他程序設計 72.1.7 相關的數據表 82.2 模塊2 83 接口設計 94 配置文件說明 105 非功能性需求設計 116 附錄 127 圖表目錄 13引言編寫目的［編寫說明］簡要地說明設計的目的.范圍［編寫說明］簡要說明本系統的實現細節,不包括概要設計部分,也不包括系統中硬件的設計.例如：1. 細化模塊的詳細劃分.2. 確定系統的命名規則(模塊、類、方法等),確保系統的設計風格與代碼的風格一致.3. 定義模塊間接口方法命名標準、入參格式、返回格式.4. 規定編碼規范及其他設計約束.5. 確定底層類實現所采用的技術框架.6. 確定選取表現層的技術,及其展示的統一風格.…指明本文檔的讀者.術語［編寫說明］列出本文件中用到的專門術語的定義和縮寫詞的原詞組及說明.可以援引概要設計說明書中的相關說明,或省略.縮寫、術語說明參考資料［編寫說明］列出編寫本說明書時參考的文件(如經核準的工作任務說明書或合同等)、資料、技術標準,以及他們的作者、標題、編號、發布日期和出版單位.可以援引概要設計說明書中的相關說明,或省略.約定［編寫說明］說明本文件中版式編排、特殊字體及標記等相關約定.模塊設計［編寫說明］對《概要設計說明書》所定義的每一個模塊進行詳細說明.模塊1描述［編寫說明］對模塊進行描述,包括模塊ID,模塊名稱(如文件名稱等),實現的功能等.用戶界面［編寫說明］對有用戶界面的模塊,描繪模塊的操作界面圖,并進行界面單元功能描述.類設計［編寫說明］如果本模塊有類,說明為了實現本模塊功能需要使用到的類的描述.類圖［編寫說明］圖示本模塊及相關模塊的類圖. 類1(名稱)1. 屬性1：名稱及描述2. 屬性2：名稱及描述3. …4. 方法1：名稱、功能描述、參數描述、返回值描述、方法結構、方法算法描述5. 方法26. …類2參照類1方式進行描述.處理流程［編寫說明］采用流程圖(時序圖、協作圖等)、文字、表格等形式描述模塊的全部處理流程,說明相關的數據流,條件,入口和出口等信息.關聯模塊［編寫說明］說明為了實現本功能需要調用的其它模塊、類或方法.其他程序設計［編寫說明］如果本模塊有諸如腳本語言等程序設計,參照如下方式描述.［裁剪說明］根據項目實際情況,可以裁剪.程序之間的關系［編寫說明］可以以圖示、表格、文字等形式說明程序之間及與相關類的關系.程序11. 程序名稱2. 功能描述3. 算法描述 程序2［編寫說明］參照程序的方式進行描述.相關的數據表［編寫說明］本模塊如引用數據表說明相關數據表的名稱等信息.本模塊如引用存儲過程、視圖等數據庫對象及其他數據結構等,可以參照數據表的描述方式進行描述.模塊2參照模塊1的方式進行編寫,以此類推.接口設計［編寫說明］對《概要設計說明書》中定義的接口進行細化,接口描述應包含以下一些內容：1. 用途說明接口的功能.2. 輸入說明調用該接口需要輸入哪些數據.3. 參數、數據格式說明調用本接口需要的參數,并詳細描述參數的具體格式.4. 通訊協議指出采用的通訊協議.5. 輸出說明調用本接口后的結果.6. 異常情況處理描述使用該項界面數據過程中,若出現異常情況的話,如何處置.配置文件說明［編寫說明］本系統如有配置文件,描述配置文件格式和配置方法非功能性需求設計［編寫說明］針對《概要設計說明書》中定義的非功能性需求,包括安全性、性能、日志、自管理等進行具體設計.附錄圖表目錄附圖目錄TOC\h\z\t"附圖標題"\c附圖1. 附圖 錯誤!未定義書簽.附圖2. 附圖 錯誤!未定義書簽.表格目錄