軟件詳細設計說明模板-類設計版

1、軟件詳細設計說明V4.0-2XX-XXX-XX標記數(shù)量修改單號簽字日期編制XXXX會簽軟件詳細設計說明校對XXXX標檢XXXX共9頁第1頁審核批準XXXX中國船舶工業(yè)系統(tǒng)工程研究院會簽XXXXGr002.6C軟件詳細設計說明修訂記錄版本號修訂狀態(tài)簡要說明修訂內容和范圍修訂日期修訂人批準日期注：修訂記錄在體系文件發(fā)布后換版時使用，修訂狀態(tài)欄填寫：A增加，MH修改,D刪除5目次1范圍21.1標識21.2系統(tǒng)概述21.3文檔概述22引用文檔23 CSCI詳細設計 23.1類的唯一標識（XX類）33.1.1 類說明33.1.2類數(shù)據(jù)33.1.3類操作33.2數(shù)據(jù)庫表設計（可選）54需求可追蹤性55注釋

2、5圖1 XX操作活動圖圖序4表1類列表2表2類變量/數(shù)據(jù)說明表3表3 類操作描述表 3表4所用算法4表5 函數(shù)描述表4表6 數(shù)據(jù)庫表結構 5表7 需求追蹤表（正向） 5表8 需求追蹤表（逆向） 5Gr002.6C軟件詳細設計說明1范圍1.1 標識本條應描述本文檔所適用系統(tǒng)和軟件的完整標識，適用時，包括其標識號、名 稱、縮略名、版本號和發(fā)布號。簡要說明軟件的標識號、發(fā)布號、名稱、縮略名、版本號。a）軟件標識號：b）發(fā)布號：V01c）名稱：d）縮略名：e）版本號：V1.01.2 系統(tǒng)概述本條應概述本文檔所適用系統(tǒng)和軟件的用途。分別簡要說明系統(tǒng)的用途、軟件用途標識需方、用戶、開發(fā)方等。a）需方：b）

3、用戶：c）開發(fā)方：1.3 文檔概述本條應概述本文檔的用途和內容，并描述與它的使用有關的保密性方面的要求。2引用文檔本章應列出引用文檔的編號、標題、編寫單位、修訂版及日期，還應標識不能 通過正常采購活動得到的文檔的來源。示例：a）文檔名稱1，編號（若有），編寫單位，版本（若有），日期；b）文檔名稱2，編號（若有），編寫單位，版本（若有），日期。3 CSCI詳細設計本文檔詳細描述的類列表如表1所示。表1類列表序號類標識類名稱備注1.2.3.4.注釋：1. 軟件項目負責人根據(jù)項目實際情況，選擇主要的類進行詳細描述。類列表中 的類需進行跟蹤。2. 該列表中至少包含概要設計中的類3.1 類的唯一標識（X

4、X類）3.1.1 類說明給出該類的簡要描述。3.1.2 類數(shù)據(jù)對類變量/數(shù)據(jù)進行說明。表2類變量/數(shù)據(jù)說明表數(shù)據(jù)名稱標識可見性數(shù)據(jù)類型數(shù)據(jù)說明發(fā)送業(yè)務信 息界面m_form_se ndl nfoprivate3.1.3 類操作描述類的具體操作函數(shù)，對函數(shù)輸入輸出參數(shù)進行說明，對函數(shù)處理過程可以 采用活動圖的方式進行描述。表3類操作描述表序號操作標識操作名稱可見性功能描述5.lnit_Ywxx_lnterface初始化業(yè)務信息查詢 界面private顯示業(yè)務信息查詢界面控件6.7.8.注釋：使用者可以根據(jù)習慣選擇使用3.1.3.1章節(jié)形式（建議邏輯流程復雜，活動圖 較多時使用）或者3.1.3.2

5、章節(jié)表格形式（建議邏輯流程簡單，活動圖較少或者不需要使用活動圖描述時使用）對類的操作進行描述。3.1.3.1操作標識（操作名稱）a）數(shù)據(jù)元素對該操作所用到的數(shù)據(jù)元素進行定義。如此內容已在前面描述可在此引用或省 略。b）邏輯流程以活動圖的形式對該操作的順序、動態(tài)控制序列，異常與錯誤處理等內容進行 描述。5圖1 XX操作活動圖C）所用算法表4所用算法d）其它設計如有需要，給出類設計中的約束、限制或非常規(guī)特征；要使用的規(guī)定 CSCI語言 之外的編程語言和它的使用原理等。3.1.3.2表5 函數(shù)描述表函數(shù)定義返回值函j數(shù)名稱（參數(shù)）所屬接口名稱接口標識簡單描述描述一下這個函數(shù)的功能和作用。名稱in/o

6、ut類型簡短描述參數(shù)說明參數(shù)名 稱填寫 in （輸 入）或者out（輸 出）類型描述參數(shù)的相關說明，可以包括數(shù)據(jù)值的有效范 圍，輸出的形式、數(shù)里和頻度，輸出媒體、對輸 出圖形及符號的說明、安全保密條件等等。若是 數(shù)據(jù)結構類型，則在 4.1.6中描述。返回值示例：true:配置站位成功； false:配置站位失敗。邏輯流程 （可選）以活動圖的形式對該操作的順序、動態(tài)控制序列，異常與錯誤處理等內容進 行描述。算法描述對使用的算法進行簡單描述，包括輸入、輸出及算法本身。其它設計如有需要，給出類設計中的約束、限制或非常規(guī)特征；要使用的規(guī)定CSCI語言之外的編程語言和它的使用原理等。3.2 數(shù)據(jù)庫表設計（可選）若是有數(shù)據(jù)庫設計說明或者在概要設計文檔中已說明，則本節(jié)可選。示例:表6數(shù)據(jù)庫表結構序 號字段名稱字段標識字段類型長度主鍵外鍵非空注釋1是/否是/否是/否默認值等24需求可追蹤性表7 需求追蹤表（正向）軟件詳細設計說明軟件概要設計說明類標識/名稱章條號包標識/名稱章條號XX3.2.1XX