軟件模塊詳細設計模板_第1頁
軟件模塊詳細設計模板_第2頁
軟件模塊詳細設計模板_第3頁
已閱讀5頁,還剩17頁未讀 繼續免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

1、技術文件技術文件名稱: <XXX>技術文件編號:版 本:擬制審核會簽標準化批準中興軟件技術(南昌)有限公司版本變更記錄文件編號版本號擬制人 /修改人擬制/修改日期更改理由主要更改內容(寫要點即可)注 1 :每次更改歸檔文件(指歸檔發布數據庫)時,需填寫此表。注 2:文件第一次歸檔時, “更改理由 ”、“主要更改內容 ”欄寫 “無”。目錄版本變更記錄 目錄 iii1 引言 1-21.1 編寫目的 1-21.2 適用范圍 1-21.3 預期讀者和閱讀建議 1-21.4 參考資料 1-21.5 引用標準文件 1-22 術語、定義與縮略語 2-22.1 術語、定義 2-22.2 縮略語 2

2、-33 模塊一 錯誤 ! 未定義書簽。3.1 模塊描述 3-33.2 標準模塊(可選) 3-33.3 模塊設計 3-33.4 類定義 3-63.4.1 類一 錯誤 !未定義書簽。3.5 單元定義(可選) 3-173.5.1 單元一 3-17說明本模版中用“ <>”引起來的藍色斜體字為撰寫模版內容的使用說明或解釋, 請在完 成之后刪除這部分內容。本模版中列出應該填寫內容框架,為了通用則不可避免犧牲應對具體情況的靈活 性,若其中部分欄目的內容不適用,則必須在該欄目中填寫“無” ,禁止刪除欄目 或空白,以免產生缺失或遺漏的誤導。本模版的解釋權歸公司技術管理部所有。>1 引言1.1

3、編寫目的定義 <XXX 項目 >需求開發和管理的相關約定和活動。1.2 適用范圍適用于 <XXX 項目 >需求開發和管理。1.3 預期讀者和閱讀建議預期讀者和閱讀建議見表 1。表1讀者分類閱讀重點備注無1.4 參考資料無。1.5 引用標準文件無。2 術語、定義與縮略語2.1 術語、定義術語、定義見表 2表2術語 / 定義說明無2.2 縮略語縮略語見表 3。表3縮略語原文中文含義無3 用戶管理模塊3.1 模塊描述要求:從模塊在系統中的位置,實現原理及方式、實現的主要功能等方面來描述該模塊的 概貌。 實現的原理及方式:實現的主要功能: 查找好友:用戶能夠根據自己的需求對在線

4、的用戶進行查找。添加好友: 用戶可以把查找到的好友添加到自己的好友列表里面,從而可以和好友進行通訊。刪除好友:用戶也可以對自己不想要通訊的用戶進行刪除。3.2 標準模塊(可選)要求:說明在產品模塊庫、事業部模塊庫中對標準模塊查詢結果、指出引用的標準模塊的 內容和應用方式、描述本模塊中可能抽象的公用模塊及其應用范圍 Z 模塊設計要求:主要用文字、圖表等形式詳細描述該模塊的狀態遷移、信號流程、程序流程、界面 安排、進程關系、異常處理、錯誤處理等方面。詳細說明本模塊中的可測試性設計,包括提供的測試接口,測試內容和范圍等。3.3 類定義CSearchUser3.3.1.1 描述 <要求:簡述此類

5、下列相關內容: 實現功能 在模塊中起到的作用 引用此類應注意的事項。 > 實現功能:3.3.1.2 引用包列表或頭文件 <要求:簡述此類下列相關內容: 例如:3.3.1.3 繼承(實現)關系< 要求:繼承(實現)的類(接口)的包的完整路徑。例如: 3.3.1.4 屬性< 要求:描述屬性名稱、含義、數據類型、訪問類型、修飾符以及初始值。 >3.3.1.4.1 m_UserID含義< 例如:用戶名 用戶 ID數據類型< 例如: 。 >訪問類型< 例如: private 。 >public修飾符< 例如:無。 >初始值<

6、例如: null 。 >3.3.1.4.2 m_UserName含義< 例如:用戶名。 > 用戶昵稱數據類型< 例如: 。 >訪問類型< 例如: private 。 > public 修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.1.4.3 m_Password含義< 例如:用戶名。 > 用戶密碼數據類型< 例如: 。 >訪問類型< 例如: private 。 > public 修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.1.4

7、.4 m_Popedom含義< 例如:用戶名。 >用戶權限數據類型< 例如: 。 >訪問類型< 例如: private 。 >public修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.1.4.5 m_Remark含義< 例如:用戶名。 >保存備注數據類型< 例如: 。 >訪問類型< 例如: private 。 >public修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.1.5 方法3.3.1.5.1 void CSearchUser:O

8、nSearchUser()功能描述顯示“查找 /添加用戶”對話框,根據用戶設定的用戶帳號、昵稱等信息查找所有在線 用戶。訪問類型< 例如: private 。 >private修飾符< 例如: static。 >輸入< 要求:給出本函數的輸入參數的詳細說明 , 包括取值范圍、含義,及參數間的控 制、順序、獨立或依賴等關系。 >算法與處理流程<要求:說明本函數的關鍵實現方法與處理流程。明確對程序的注釋。規定對信息 是否有特殊的編碼要求。 >1、聲明一個 CUser 對象2、聲明一個 CUserManage對象3、調用 CUser對象的 SetUse

9、rID(CString m_UserID) 等方法將輸入的用戶信息;4、使用一個 if 語句調用 CUserManage對象的 IsExist(CString m_UserID) 方法檢驗輸 入的用戶信息是否有效,有效的話,彈出一個 MessageBox() 對話框,確定的話執行 就調用 CUserManage 對象的 SearchUser(CUser user) 方法查找一個新用戶,否則不 做任何操作輸出<要求:給出本函數的輸出參數的詳細說明。它主要包括它的輸出值、取值范圍、 含義及參數間的控制、順序、獨立或依賴等關系。 >返回< 要求:說明返回值的含義。 >CAdd

10、User3.3.2.1 描述<要求:簡述此類下列相關內容: 實現功能在模塊中起到的作用 引用此類應注意的事項。 >3.3.2.2 引用包列表或頭文件<要求:簡述此類下列相關內容:例如:3.3.2.3 繼承(實現)關系< 要求:繼承(實現)的類(接口)的包的完整路徑。例如: 3.3.2.4 屬性< 要求:描述屬性名稱、含義、數據類型、訪問類型、修飾符以及初始值。 >3.3.2.4.1 m_UserID含義< 例如:用戶名。 >用戶 ID數據類型< 例如: 。 >訪問類型< 例如: private 。 >public修飾符&l

11、t; 例如:無。 >初始值< 例如: null 。 >3.3.2.4.2 m_UserName含義< 例如:用戶名。 > 用戶昵稱數據類型< 例如: 。 >訪問類型< 例如: private 。 > public 修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.2.4.3 m_Password含義< 例如:用戶名。 > 用戶密碼數據類型< 例如: 。 >訪問類型< 例如: private 。 > public 修飾符< 例如:無。 >初始值< 例

12、如: null 。 >3.3.2.4.4 m_Popedom含義< 例如:用戶名。 >用戶權限數據類型< 例如: 。 >訪問類型< 例如: private 。 >public修飾符< 例如:無。 >初始值< 例如:null 。>3.3.2.4.5 m_Remark含義< 例如:用戶名。 >保存備注數據類型< 例如: 。 >訪問類型< 例如: private 。 >public修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.2.5 方法3.3.2.5.1

13、 void CAddUser:OnAddUser()功能描述顯示“查找 /添加用戶”對話框,根據用戶設定的用戶帳號、昵稱等信息或者查找到的 用戶信息,在數據庫中新增一條用戶記錄。以后在用戶的好友列表中就會顯示新增的好友。訪問類型< 例如: private 。 >private修飾符< 例如: static。 >輸入< 要求:給出本函數的輸入參數的詳細說明 , 包括取值范圍、含義,及參數間的控 制、順序、獨立或依賴等關系。 >算法與處理流程<要求:說明本函數的關鍵實現方法與處理流程。明確對程序的注釋。規定對信息 是否有特殊的編碼要求。 >1、聲明一

14、個 CUser 對象2、聲明一個 CUserManage對象3、調用 CUser 對象的 SetUserID(CString m_UserID) 等方法將輸入的用戶新增信息保 存到 CUser 對象的各個成員變量中;4、使用一個 if 語句調用 CUserManage對象的 IsExist(CString m_UserID) 方法檢驗輸 入的用戶信息是否有效,有效的話,彈出一個 MessageBox() 對話框,詢問用戶是否添 加新用戶,確定的話執行就調用 CUserManage 對象的 AddUser(CUser user) 方法添加 一個新用戶,否則不做任何修改輸出<要求:給出本函數

15、的輸出參數的詳細說明。它主要包括它的輸出值、取值范圍、 含義及參數間的控制、順序、獨立或依賴等關系。 >返回< 要求:說明返回值的含義。 >CDelUser3.3.3.1 描述<要求:簡述此類下列相關內容:實現功能在模塊中起到的作用 引用此類應注意的事項。 >3.3.3.2 引用包列表或頭文件<要求:簡述此類下列相關內容:例如:3.3.3.3 繼承(實現)關系< 要求:繼承(實現)的類(接口)的包的完整路徑。例如: 3.3.3.4 屬性< 要求:描述屬性名稱、含義、數據類型、訪問類型、修飾符以及初始值。 >3.3.3.4.1 m_UserI

16、D含義< 例如:用戶名。 >用戶 ID數據類型< 例如: 。 >訪問類型< 例如: private 。 > private修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.3.4.2 m_UserName含義< 例如:用戶名。 > 用戶昵稱數據類型< 例如: 。 >訪問類型< 例如: private 。 > private 修飾符< 例如:無。 >初始值< 例如:null 。>3.3.3.4.3 m_Password含義< 例如:用戶名。 >用戶密

17、碼數據類型< 例如: 。 >訪問類型< 例如: private 。 > private修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.3.4.4 m_Popedom含義< 例如:用戶名。 > 用戶權限數據類型< 例如: 。 >訪問類型< 例如: private 。 > private 修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.3.4.5 m_UserList含義< 例如:用戶名。 > 列表控件變量數據類型< 例如: 。 >

18、訪問類型< 例如: private 。 > private 修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.3.4.6 m_Index含義< 例如:用戶名。 > 選定的用戶記錄數據類型< 例如: 。 >訪問類型< 例如: private 。 > private 修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.3.4.7 m_CUserList含義< 例如:用戶名。 > 保存用戶列表信息數據類型< 例如: 。 >訪問類型< 例如: pr

19、ivate 。 > private 修飾符< 例如:無。 >初始值< 例如: null 。 >3.3.3.5 方法void CDelUser:OnInitDialog()功能描述顯示用戶列表。訪問類型< 例如: private 。 > public 修飾符< 例如: static。 >輸入< 要求:給出本函數的輸入參數的詳細說明 , 包括取值范圍、含義,及參數間的控 制、順序、獨立或依賴等關系。 >算法與處理流程 <要求:說明本函數的關鍵實現方法與處理流程。明確對程序的注釋。規定對信息 是否有特殊的編碼要求。 >1、

20、聲明一個 CUserManage對象2、調用 CUserManage 對象的 GetUserList(CArray<CUser,CUser>*UserList) 方法獲取 數據庫里用戶列表3、使用一個 for 循環逐條顯示用戶列表輸出<要求:給出本函數的輸出參數的詳細說明。它主要包括它的輸出值、取值范圍、 含義及參數間的控制、順序、獨立或依賴等關系。 >返回< 要求:說明返回值的含義。 >void CDelUser:OnClickList(NMHDR* pNMHDR, LRESULT* pResult)功能描述選擇用戶訪問類型< 例如: private

21、 。 >public修飾符< 例如: static。 >輸入< 要求:給出本函數的輸入參數的詳細說明 , 包括取值范圍、含義,及參數間的控 制、順序、獨立或依賴等關系。 >算法與處理流程<要求:說明本函數的關鍵實現方法與處理流程。明確對程序的注釋。規定對信息 是否有特殊的編碼要求。 >1、聲明一個整型變量 m_index ,作為一個索引2、調用列表控件成員變量 m_userlist 的 GetSelectionMark() 方法, 獲得在列表中選中的 用戶,并將 GetSelectionMark() 方法的返回值賦給 m_index3、調用列表控件成員

22、變量 m_userlist 的 GetItemText(index, N) 方法,將選中的用戶信 息保存到輸入框變量中輸出<要求:給出本函數的輸出參數的詳細說明。它主要包括它的輸出值、取值范圍、 含義及參數間的控制、順序、獨立或依賴等關系。 >返回< 要求:說明返回值的含義。 >3.3.3.5.3 void CDelUser:OnDelUser()功能描述刪除用戶信息訪問類型< 例如: private 。 > public 修飾符< 例如: static。 >輸入< 要求:給出本函數的輸入參數的詳細說明 , 包括取值范圍、含義,及參數間的控 制、順序、獨立或依賴等關系。 >算法與處理流程 <要求:說明本函數的關鍵實現方法與處理流程。明確

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論