研發生產中心文檔編號版本A1密級商密A項目名稱Xx系統項目來源Xxx系統

詳細設計說明書［內部資料請勿外傳）XX公司版權所有不得復制文檔變更記錄序號麥更（+L）說明作者版本號日期批準12目錄引言41.1編寫目的和范圍41.2術語表41.3參考資料41.4使用的文字處理和繪圖工具4全局數據結構說明52.1常量52.2變屋52.3數據結構5模塊設計53.1用例圖53.2功能設計說明5模塊15模塊26接口設計74.1內部接口74.2外部接口74.2.1接口說明74.2.2調用方式85.數據庫設計86系統安全保密設計86.1說明86.2設計86.2.1數據傳輸部分8IP過濾分部86.2.3身份驗證部分8系統性能設計9系統岀錯處理91.1背景此文檔的背景1.2編寫目的和范圍說明寫這悅詳細設計說闕書的目的。本詳細設計說明書編寫的目的是說明程序模塊的沒計考慮,包括程序堆述、輸入/輸出、算送和流程邏輯等,為軟件編程和系統維護提供基礎。本說明節的預期讀者為系統設計人靈、軟件開發人員、軟件測試入員和頊目評審入員。1.3術語表定義系統或產品中涉及的重妾術語9為讀者在閱讀文檔時提供必耍的參考信息°序號術語或縮略語說明性定義1PMProjectManager,項目經理21.4參考資料列出有關資料的名琢、作者、文件編號或版本等。參考資料包樂乩需求說綢書、架構設計說明書等;b.本項目的其他已發表的文件:C.引用文件、資科、軟件開發標準等。紅料名稱作者文件編號、版本遙料存放地點1.5使用的文字處理和繪圖工貝文字處理軟件:〔編寫設計文檔使用的文字處理軟件，如RedOffice]維圖工具:（使用的U仏工具-?iSRose.環、Visio]設計概述2.1任務和目標2.1.1需求概述2.1.2運行壞境概述2.1.3條件與限制2.1.4詳細設計方法和工具系統詳細需求分析主要對系統級的霊求逬行分析。苣先殛對需求分析提出的企業需求進一歩確兒并對由于情況變化而帝來的需求變化選行較為詳細的分析。3.1詳細需求分析3.1.1詳細功能需求分析3.1.2詳細性能需求分析3.1.3詳細資源需求分析3.1.4詳細接口需求分析3.1.5詳細系統運行環境及限制條件分析總體方案確認著重解決乘統總體結檢確認及界面創分問題。4.1系統總體結構確認對系統組成、邏輯結構及層次遂行確認,對應用系統、支樣系統及各自實現的功能進行確認,細化集成設計及爲統工作流程,特別要注意因軟件的引進造成的系統本身結搗和公司英他奈統餡結構變化。包括:4.1.1系統組成、邏輯結構及層次確認4.1.2應用系統結構確認4.1.3支撐系統結構確認4.1.4系統集成確認4.1.5系統工作流程確認4.2系統詳細界面劃分4.2.1應用系統與支撐系統的詳細界面劃分應用系統與支撐系統之間的界廊包括系統主眾務器與其他服務器的服務范圍及訪問方式,網絡及數據庫對應用爲統的支撐方式,全局數據的管理與存取方式等。4.2.2系統內部詳細界面劃分系統各訪能之間的界血包括覆竈范圍,模塊間豹能調用涉及到的系統模塊及方法，全局數據格式j系統性能要求等。全局數據結構說明本章說明本程序系統中使用的全局數據常量、變量和數據結構。5.1常量包括數據文件名琢及其所在且錄,功能說陰,具體常量說頤等。5.2變量本章說明本程序系統中使用的全局數據常量、變量和數據結構。5.3數據結構包括數據結構名隸,功能說明，具體數擾結構說明〔定文、注釋、取值〉氛系統詳細設計6.1功能結構圖6.2系統結構設計及子系統劃分對系統的組成及邏輯結構迸行設計前確認。劃分系統功能模塊或子系統（如果有或者有必要,特別是大型的軟件系統）°6.3系統功能模塊詳細設計按結構化設計方法,在系統功能逐層分解的基礎上,貳系統各功能模塊或子黍統進行設計A曲為詳細設計的主妥部分之一°用層次酉擔述系統的總悴結構、功能分解及各個漠塊之間的相互調用關系和宿息交互,用IPQ圖或其他方法描述各模塊完成的功能。以上建議采用HIFO圖進斎幼能分燼與模塊箱述，更髙的妾求建議采用IDEH）方法逬行為j能模型設計「詳細設計應用系統的各個構成模塊完成的功能及其相互之間的關系，用］P0或結構圖描述各模塊的組成結構、算法、樓塊間的接口關縈,以及需求、迷能和模塊三者之間的交叉參照關系。每個模塊的描述說明可參照以下格式:模塊編號:棧塊色隸處理:算法描述:輸出:其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對詳細設計更高餡要求建議用IDEFO圖進行各功能模塊的設計。如果對歎件蠱迸行二次開發（包括功能擴慝、功能改造、用戶界面改適等）,則相應的設計工作應該設立子課題完成。6.4系統界?面詳細設計系統界面說明應用泵統軟件的各種樓口。整個系統的其他樓口（如系統硬件緩口、通訊接口等）在相應餉部分說明。6.4.1外部界面設計根根系統寮廊劃分進行系統夕卜部界面設計,對系統的所有處部接口（包括功能和數裾凄口）進行設計。6.4.2內部界面設計設計系統內部各功能模塊間的調用關系和數據接口。643用戶界面設計規定人機賽面的內容、界面風格、調舟方式等,包括顱謂的表單設計、報表設計和用戶需要的打印綸岀筆設計。此部分內容可能比較多。開發和測試生產環境說明7.1開發環境7.2測試及產品壞境-Developmentevnironment:programminglanuague,databaseVs2010-svn-iss6.1+-mysql/sqlserver2005/2008-.netframwork4.0-Testing&productionenvironmentOS,database?.netframwork4.0Windwos2003,iis6.0,MySQL&模塊設計8.1用例圖8.2功能設計說明&2.1模塊1模塊1主要分為以于幾個子模塊;子模塊A子模塊2和子模塊也&2.1.1子模塊.1設計圖.2功能描述簡要損述子模塊1的業務功能。.3輸入數扌居詳細描述用戶魏入的數裾〔包括任何輸入設備）以及這些數榻的有效性檢驗規則。詳細描述從物鋰模型中的哪些表農取數視以及獲取這些數視的條件。.4輸出數據詳細撞述子功能1所產生的數梅以及這些數據的表現形式。.5業務算法和流程從業務角度詳細描述根裾輸入數據產生輸出數據餡業務算法和潦程。.6數據設計給出本程序中的局部數據結構說頤,包括數據結構名稱,功能說明,具體數據結構說明傳戈、注釋設計、取值）等?相關數據庫表,數據存鎧設計C具體說明需要張文件方式保存的數據文件名、數握存儲格式、數據項及屬性等。）.7源程序文件說明紿出本程序的各源程序文件的說明,包括源程序文件名稱及其質在目錄,功能說明,包含的前導文件及函數名稱等。.8更數說明具體說明本程序中的各個函數,包括函數名稱及其撚在文件,功能,格式,參數?全局變量，局部變呈,返回值「算法說明°使用約束等。.9限制條件.10其他說明8.2.2模塊2模塊1主要分為以下幾個子模塊:予模塊1＞子模塊2和子模塊M子模塊.1設計圖.2功能描述簡要描述子模塊1的業務功能..3輸入數據詳細描述用戶輸入的數榻（包括任何輸入設備）以及這些數榻的有效性檢驗規詳細描述從物理模型中的哪些表獲取數據以及獲取這些數據的條件。8.221.4輸出數據詳細描述子功能1所產生的數提以及這些數粧的表現形式。.5業務算法和流程從業務角度詳細描述根據綸入數據產生輸出數據的業務算法和流程。.6數據設計給出本程序中的局部數據結構說綢,包括數據結構屯稱,功能說明,具體數據結構說明（定義、注釋設計、取值）等。相關數據庫表,數據存腿設計（具體說明需要以文件方式保存的數據文件名、數據存儲格式、數根項及屬性等.）.7源程序文件說明給出?本程序的各源程序文件的說綢,包括源程序文件名稱及其所在目錄,功能說陰,包含的聽導文件及函數名稱等。.8函數說明具體說明本程序中的各個函數,包話函數名稱及其所在文件,功能,格式,參哉，全局變壹.局部變亶返回值』算法說明,使用約束等。9限制條件.10其他說明接口設計9.1內部接口9.2外部接口9.2.1接口說明洌如:XX干熹統通過XX從XX子系統取得^等,相關標準,調用示鴻可根梶気妥増加章節播述接口。922調用方式例如：內部接口調月:例:/沁*通過用戶眾務號碼取得該客戶認證密碼等信息*如果該客戶存在返回為0,其他情況參考錯誤編碼VpublicRUserlnfogeWserlnfo(StringaserNo);數據庫設計詳見［xxx數據庫設計說貂書］如果數裾庫設計內容比較少,剛直接在此處描述0系統安全保密設計11.1說明例如:由于存在與外部棄統的樓口，更以需要考慮訪問安全的問題、112設計例如:分為數據錢娥部分,丹過濾部分,身份驗證部分.［章節可補充］11.2.1數據傳輸部分洌如,在部分數據傳遞的時候,考慮以h憂ps松議,需妥在部署的時候作相關處理.11.2.2IP過濾分部例如:可在系統前端通過Filter實現,該Filler實硯對該地址訪問的IP過濾作用、可信任IP地址通過文件迸行配置.11.2.3身份驗證部分例如:對信任的用戶,頒發身份驗證碼,通過該標識進行身份識別.系統性能設計系統出錯處理例如:為了在系統出現異常情況下給用戶哄明確的提示,可采用兩種方式予以提不:人使用的abN()函數直接謹示,這主妥在輸入或條改的情況下使用;、2?使用統一的錯誤界面提示,該賽面對應于應口沖超e.jsp頁血。錯誤界面樣式如下圖所示:錯渓提示： “錯誤提示內容"錯誤捉示畀面設計和開發規范I可以列表方式列出設計開發的參考文檔的索引,內容較少/關鍵內容可以童填呵14.1數據庫設計規范14.2-NET編碼規范特別強調：令詳細請參刃《ASP.Net文檔規范》§這里只做簡單闡述，如有變動，會及時冋事整個頂□纟且相關人員。不要給類名加前綴。使用PascalCasing風格，不便用匈牙利命名法。要用名詞詞組來給類型命名。使用PascalCasing風格°類名少用縮寫，不要使用下劃線字符()。基類CBase的文件名為：FileBase.cs;泛型類命名：考慮用T來命名參數類型，類如：publicclassList<T>。接口(Interface)命名規范和類命名規范相同，唯一區別是接口在名字前加上"I"前綴。枚舉命名：以戻數結尾，表明這是一個枚舉，例如：EnumColorButtons結構命名：表明這是一個結構休，例如：StructureCustomerInfoRecord'以Record結尾令除使用工旦直接生成的類外，其它所有炎的功能要有注釋，即使只是一個數據對象；非常見功能的API必須要有功能描述的注釋。獨立的要被應用具他功能所調用的模塊的接口和公共API的注釋耍完備，即包括功能說明、參數和返回值說明。具它情況的API的注釋盡量完備，但不強制要求。令一次性的流打開后必須關閉和釋放。一般地，在流打開后，都有一個trycatch語句，務必加上finally塊釋放流資源。令即使IF,While是單語句，也要使用"{}"來劃分程序塊。令不要有完全為調試使用的日志信息，如("1");如要使用，在調試完成后請及時刪除。令一些常識性代碼，不需要寫沒必耍的注釋。令不要用工具生成沒用的注釋。

14.3代碼目錄結構【刃解決方案【刃解決方案Authority12個項目）X腳本文普日?￡田田!Authority21Properties空引用_App_Data乙ContentIt口ImagesQ—Scripts曰L-7jquery-easyui-1?2.6ffi匚Jlocale51口plugins(2C3themes仝】easyloader.jsjquery-1.7.2.min.jsjquery,easyui?min?js匕口口巳盤fflfflffla田田QSUJjquery-ui-18.20匕口口巳盤fflfflffla田田QControllersModelsScriptsVievsGlobal,asaxVebconfig結構說明:作用范圉包名描述整個程序ContentImages存放圖片ScriptsJquery以及樣式表等Scripts/jquery-easyui-1.2.6jquery-easyui包數字為版本Scripts/jque