軟件模塊詳細(xì)設(shè)計(jì)模板

1、技 術(shù) 文 件技術(shù)文件名稱：<XXX>技術(shù)文件編號(hào)： 版 本： 擬 制 審 核 會(huì) 簽 標(biāo)準(zhǔn)化 批 準(zhǔn) 中興軟件技術(shù)（南昌）有限公司版本變更記錄文件編號(hào)版本號(hào)擬制人/修改人擬制/修改日期更改理由主要更改內(nèi)容（寫要點(diǎn)即可）注1：每次更改歸檔文件（指歸檔發(fā)布數(shù)據(jù)庫(kù)）時(shí)，需填寫此表。注2：文件第一次歸檔時(shí)，“更改理由”、“主要更改內(nèi)容”欄寫“無(wú)”。目錄版本變更記錄ii目錄iii1引言1-21.1編寫目的1-21.2適用范圍1-21.3預(yù)期讀者和閱讀建議1-21.4參考資料1-21.5引用標(biāo)準(zhǔn)文件1-22術(shù)語(yǔ)、定義與縮略語(yǔ)2-22.1術(shù)語(yǔ)、定義2-22.2縮略語(yǔ)2-33模塊一3-33.1模

2、塊描述3-33.2標(biāo)準(zhǔn)模塊（可選）3-33.3模塊設(shè)計(jì)3-33.4類定義3-3類一3-33.5單元定義（可選）3-5單元一3-5<說(shuō) 明n 本模版中用“<>”引起來(lái)的藍(lán)色斜體字為撰寫模版內(nèi)容的使用說(shuō)明或解釋，請(qǐng)?jiān)谕瓿芍髣h除這部分內(nèi)容。n 本模版中列出應(yīng)該填寫內(nèi)容框架，為了通用則不可避免犧牲應(yīng)對(duì)具體情況的靈活性，若其中部分欄目的內(nèi)容不適用，則必須在該欄目中填寫“無(wú)”，禁止刪除欄目或空白，以免產(chǎn)生缺失或遺漏的誤導(dǎo)。n 本模版的解釋權(quán)歸公司技術(shù)管理部所有。>1 引言1.1 編寫目的定義<XXX項(xiàng)目>需求開發(fā)和管理的相關(guān)約定和活動(dòng)。1.2 適用范圍適用于<X

3、XX項(xiàng)目>需求開發(fā)和管理。1.3 預(yù)期讀者和閱讀建議預(yù)期讀者和閱讀建議見(jiàn)表1。表 1讀者分類閱讀重點(diǎn)備注無(wú)1.4 參考資料無(wú)。1.5 引用標(biāo)準(zhǔn)文件無(wú)。2 術(shù)語(yǔ)、定義與縮略語(yǔ)2.1 術(shù)語(yǔ)、定義術(shù)語(yǔ)、定義見(jiàn)表2表 2術(shù)語(yǔ)/定義說(shuō)明無(wú)2.2 縮略語(yǔ)縮略語(yǔ)見(jiàn)表3。表 3縮略語(yǔ)原文中文含義無(wú)3 用戶管理模塊3.1 模塊描述<要求：從模塊在系統(tǒng)中的位置，實(shí)現(xiàn)原理及方式、實(shí)現(xiàn)的主要功能等方面來(lái)描述該模塊的概貌。>實(shí)現(xiàn)的原理及方式：實(shí)現(xiàn)的主要功能：查找好友：用戶能夠根據(jù)自己的需求對(duì)在線的用戶進(jìn)行查找。添加好友：用戶可以把查找到的好友添加到自己的好友列表里面，從而可以和好友進(jìn)行通訊。刪除好友：

4、用戶也可以對(duì)自己不想要通訊的用戶進(jìn)行刪除。3.2 標(biāo)準(zhǔn)模塊（可選）<要求：說(shuō)明在產(chǎn)品模塊庫(kù)、事業(yè)部模塊庫(kù)中對(duì)標(biāo)準(zhǔn)模塊查詢結(jié)果、指出引用的標(biāo)準(zhǔn)模塊的內(nèi)容和應(yīng)用方式、描述本模塊中可能抽象的公用模塊及其應(yīng)用范圍>Z模塊設(shè)計(jì)<要求：主要用文字、圖表等形式詳細(xì)描述該模塊的狀態(tài)遷移、信號(hào)流程、程序流程、界面安排、進(jìn)程關(guān)系、異常處理、錯(cuò)誤處理等方面。詳細(xì)說(shuō)明本模塊中的可測(cè)試性設(shè)計(jì)，包括提供的測(cè)試接口，測(cè)試內(nèi)容和范圍等。>3.3 類定義3.3.1 CSearchUser3.3.1.1 描述<要求：簡(jiǎn)述此類下列相關(guān)內(nèi)容：l 實(shí)現(xiàn)功能l 在模塊中起到的作用l 引用此類應(yīng)注意的事項(xiàng)。&

5、gt;實(shí)現(xiàn)功能：3.3.1.2 引用包列表或頭文件<要求：簡(jiǎn)述此類下列相關(guān)內(nèi)容：例如：。>3.3.1.3 繼承（實(shí)現(xiàn)）關(guān)系<要求：繼承（實(shí)現(xiàn)）的類（接口）的包的完整路徑。>3.3.1.4 屬性<要求：描述屬性名稱、含義、數(shù)據(jù)類型、訪問(wèn)類型、修飾符以及初始值。>3.3.1.4.1 m_UserIDl 含義<例如：用戶名。>用戶IDl 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.1.4.2 m_UserNamel 含

6、義<例如：用戶名。>用戶昵稱l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.1.4.3 m_Passwordl 含義<例如：用戶名。>用戶密碼l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.1.4.4 m_Popedoml 含義<例如：用戶名。>用戶權(quán)限l 數(shù)據(jù)類型<例如：。>l

7、 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.1.4.5 m_Remarkl 含義<例如：用戶名。>保存?zhèn)渥 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.1.5 方法3.3.1.5.1 void CSearchUser:OnSearchUser()l 功能描述顯示“查找/添加用戶”對(duì)話框，根據(jù)用戶設(shè)定的用戶帳號(hào)、昵稱等信息查找所有在線用戶。l 訪問(wèn)

8、類型<例如：private。>privatel 修飾符<例如：static。>l 輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說(shuō)明, 包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 算法與處理流程<要求：說(shuō)明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對(duì)程序的注釋。規(guī)定對(duì)信息是否有特殊的編碼要求。>1、聲明一個(gè)CUser對(duì)象2、聲明一個(gè)CUserManage對(duì)象 3、調(diào)用CUser對(duì)象的SetUserID(CString m_UserID)等方法將輸入的用戶信息；4、使用一個(gè)if 語(yǔ)句調(diào)用CUserManage對(duì)象的IsExist(CStri

9、ng m_UserID)方法檢驗(yàn)輸入的用戶信息是否有效，有效的話，彈出一個(gè)MessageBox()對(duì)話框，確定的話執(zhí)行就調(diào)用CUserManage對(duì)象的SearchUser(CUser user)方法查找一個(gè)新用戶，否則不做任何操作l 輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說(shuō)明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 返回<要求：說(shuō)明返回值的含義。>3.3.2 CAddUser3.3.2.1 描述<要求：簡(jiǎn)述此類下列相關(guān)內(nèi)容：l 實(shí)現(xiàn)功能l 在模塊中起到的作用l 引用此類應(yīng)注意的事項(xiàng)。>3.3.2.2 引用包列表或頭

10、文件<要求：簡(jiǎn)述此類下列相關(guān)內(nèi)容：例如：。>3.3.2.3 繼承（實(shí)現(xiàn)）關(guān)系<要求：繼承（實(shí)現(xiàn)）的類（接口）的包的完整路徑。>3.3.2.4 屬性<要求：描述屬性名稱、含義、數(shù)據(jù)類型、訪問(wèn)類型、修飾符以及初始值。>3.3.2.4.1 m_UserIDl 含義<例如：用戶名。>用戶IDl 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.2.4.2 m_UserNamel 含義<例如：用戶名。>用戶昵稱l 數(shù)

11、據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.2.4.3 m_Passwordl 含義<例如：用戶名。>用戶密碼l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.2.4.4 m_Popedoml 含義<例如：用戶名。>用戶權(quán)限l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>

12、;publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.2.4.5 m_Remarkl 含義<例如：用戶名。>保存?zhèn)渥 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.2.5 方法3.3.2.5.1 void CAddUser:OnAddUser()l 功能描述顯示“查找/添加用戶”對(duì)話框，根據(jù)用戶設(shè)定的用戶帳號(hào)、昵稱等信息或者查找到的用戶信息，在數(shù)據(jù)庫(kù)中新增一條用戶記錄。以后在用戶的好友列表中就會(huì)顯示新增

13、的好友。l 訪問(wèn)類型<例如：private。>privatel 修飾符<例如：static。>l 輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說(shuō)明, 包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 算法與處理流程<要求：說(shuō)明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對(duì)程序的注釋。規(guī)定對(duì)信息是否有特殊的編碼要求。>1、 聲明一個(gè)CUser對(duì)象2、聲明一個(gè)CUserManage對(duì)象 3、調(diào)用CUser對(duì)象的SetUserID(CString m_UserID)等方法將輸入的用戶新增信息保存到CUser對(duì)象的各個(gè)成員變量中；4、使用一個(gè)if 語(yǔ)句

14、調(diào)用CUserManage對(duì)象的IsExist(CString m_UserID)方法檢驗(yàn)輸入的用戶信息是否有效，有效的話，彈出一個(gè)MessageBox()對(duì)話框，詢問(wèn)用戶是否添加新用戶，確定的話執(zhí)行就調(diào)用CUserManage對(duì)象的AddUser(CUser user)方法添加一個(gè)新用戶，否則不做任何修改l 輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說(shuō)明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 返回<要求：說(shuō)明返回值的含義。>3.3.3 CDelUser3.3.3.1 描述<要求：簡(jiǎn)述此類下列相關(guān)內(nèi)容：l 實(shí)現(xiàn)功能l 在模塊

15、中起到的作用l 引用此類應(yīng)注意的事項(xiàng)。>3.3.3.2 引用包列表或頭文件<要求：簡(jiǎn)述此類下列相關(guān)內(nèi)容：例如：。>3.3.3.3 繼承（實(shí)現(xiàn)）關(guān)系<要求：繼承（實(shí)現(xiàn)）的類（接口）的包的完整路徑。>3.3.3.4 屬性<要求：描述屬性名稱、含義、數(shù)據(jù)類型、訪問(wèn)類型、修飾符以及初始值。>3.3.3.4.1 m_UserIDl 含義<例如：用戶名。>用戶IDl 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。> privatel 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.3.

16、4.2 m_UserNamel 含義<例如：用戶名。>用戶昵稱l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>privatel 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.3.4.3 m_Passwordl 含義<例如：用戶名。>用戶密碼l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>privatel 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.3.4.4 m_Popedoml 含義<例如：用戶名。>用戶權(quán)限

17、l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>privatel 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.3.4.5 m_UserListl 含義<例如：用戶名。>列表控件變量l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>privatel 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.3.4.6 m_Indexl 含義<例如：用戶名。>選定的用戶記錄l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：pri

18、vate。>privatel 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.3.4.7 m_CUserListl 含義<例如：用戶名。>保存用戶列表信息l 數(shù)據(jù)類型<例如：。>l 訪問(wèn)類型<例如：private。>privatel 修飾符<例如：無(wú)。>l 初始值<例如：null。>3.3.3.5 方法3.3.3.5.1 void CDelUser:OnInitDialog()l 功能描述顯示用戶列表。l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：stat

19、ic。>l 輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說(shuō)明, 包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 算法與處理流程<要求：說(shuō)明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對(duì)程序的注釋。規(guī)定對(duì)信息是否有特殊的編碼要求。>1、聲明一個(gè)CUserManage對(duì)象2、調(diào)用CUserManage對(duì)象的GetUserList(CArray<CUser,CUser>*UserList)方法獲取數(shù)據(jù)庫(kù)里用戶列表3、使用一個(gè)for循環(huán)逐條顯示用戶列表l 輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說(shuō)明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、

20、順序、獨(dú)立或依賴等關(guān)系。>l 返回<要求：說(shuō)明返回值的含義。>3.3.3.5.2 void CDelUser:OnClickList(NMHDR* pNMHDR, LRESULT* pResult)l 功能描述選擇用戶l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：static。>l 輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說(shuō)明, 包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 算法與處理流程<要求：說(shuō)明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對(duì)程序的注釋。規(guī)定對(duì)信息是否有特殊的編碼要求。>1、聲

21、明一個(gè)整型變量m_index，作為一個(gè)索引2、調(diào)用列表控件成員變量m_userlist的GetSelectionMark()方法，獲得在列表中選中的用戶，并將GetSelectionMark()方法的返回值賦給m_index3、調(diào)用列表控件成員變量m_userlist的GetItemText(index, N)方法，將選中的用戶信息保存到輸入框變量中l(wèi) 輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說(shuō)明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 返回<要求：說(shuō)明返回值的含義。>3.3.3.5.3 void CDelUser:OnDelUser()l 功能描述刪除用戶信息l 訪問(wèn)類型<例如：private。>publicl 修飾符<例如：static。>l 輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說(shuō)明, 包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>l 算法與處理流程<要求：說(shuō)明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對(duì)程序的