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

內(nèi)部公開▲PAGE1中興軟件技術(shù)（南昌）有限公司技術(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ù)庫）時(shí)，需填寫此表。注2：文件第一次歸檔時(shí)，“更改理由”、“主要更改內(nèi)容”欄寫“無”。

引言編寫目的定義<XXX項(xiàng)目>需求開發(fā)和管理的相關(guān)約定和活動(dòng)。適用范圍適用于<XXX項(xiàng)目>需求開發(fā)和管理。預(yù)期讀者和閱讀建議預(yù)期讀者和閱讀建議見表1。表SEQ表\*ARABIC1讀者分類閱讀重點(diǎn)備注無參考資料無。引用標(biāo)準(zhǔn)文件無。術(shù)語、定義與縮略語術(shù)語、定義術(shù)語、定義見表2表SEQ表\*ARABIC2術(shù)語/定義說明無縮略語縮略語見表3。表SEQ表\*ARABIC3縮略語原文中文含義無用戶管理模塊模塊描述<要求：從模塊在系統(tǒng)中的位置，實(shí)現(xiàn)原理及方式、實(shí)現(xiàn)的主要功能等方面來描述該模塊的概貌。>實(shí)現(xiàn)的原理及方式：實(shí)現(xiàn)的主要功能：查找好友：用戶能夠根據(jù)自己的需求對在線的用戶進(jìn)行查找。添加好友：用戶可以把查找到的好友添加到自己的好友列表里面，從而可以和好友進(jìn)行通訊。刪除好友：用戶也可以對自己不想要通訊的用戶進(jìn)行刪除。標(biāo)準(zhǔn)模塊（可選）<要求：說明在產(chǎn)品模塊庫、事業(yè)部模塊庫中對標(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ì)說明本模塊中的可測試性設(shè)計(jì)，包括提供的測試接口，測試內(nèi)容和范圍等。>類定義CSearchUser描述<要求：簡述此類下列相關(guān)內(nèi)容：實(shí)現(xiàn)功能在模塊中起到的作用引用此類應(yīng)注意的事項(xiàng)。>實(shí)現(xiàn)功能：引用包列表或頭文件<要求：簡述此類下列相關(guān)內(nèi)容：例如：java.util.Vectorcom.ztenc.xxx。>繼承（實(shí)現(xiàn)）關(guān)系<要求：繼承（實(shí)現(xiàn)）的類（接口）的包的完整路徑。例如：java.util.Vector>屬性<要求：描述屬性名稱、含義、數(shù)據(jù)類型、訪問類型、修飾符以及初始值。>m_UserID含義<例如：用戶名。>用戶ID數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_UserName含義<例如：用戶名。>用戶昵稱數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_Password含義<例如：用戶名。>用戶密碼數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_Popedom含義<例如：用戶名。>用戶權(quán)限數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_Remark含義<例如：用戶名。>保存?zhèn)渥?shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>方法voidCSearchUser::OnSearchUser()功能描述顯示“查找/添加用戶”對話框，根據(jù)用戶設(shè)定的用戶帳號(hào)、昵稱等信息查找所有在線用戶。訪問類型<例如：private。>private修飾符<例如：static。>輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說明,包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>算法與處理流程<要求：說明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對程序的注釋。規(guī)定對信息是否有特殊的編碼要求。>1、聲明一個(gè)CUser對象2、聲明一個(gè)CUserManage對象3、調(diào)用CUser對象的SetUserID(CStringm_UserID)等方法將輸入的用戶信息；4、使用一個(gè)if語句調(diào)用CUserManage對象的IsExist(CStringm_UserID)方法檢驗(yàn)輸入的用戶信息是否有效，有效的話，彈出一個(gè)MessageBox()對話框，確定的話執(zhí)行就調(diào)用CUserManage對象的SearchUser(CUseruser)方法查找一個(gè)新用戶，否則不做任何操作輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>返回<要求：說明返回值的含義。>CAddUser描述<要求：簡述此類下列相關(guān)內(nèi)容：實(shí)現(xiàn)功能在模塊中起到的作用引用此類應(yīng)注意的事項(xiàng)。>引用包列表或頭文件<要求：簡述此類下列相關(guān)內(nèi)容：例如：java.util.Vectorcom.ztenc.xxx。>繼承（實(shí)現(xiàn)）關(guān)系<要求：繼承（實(shí)現(xiàn)）的類（接口）的包的完整路徑。例如：java.util.Vector>屬性<要求：描述屬性名稱、含義、數(shù)據(jù)類型、訪問類型、修飾符以及初始值。>m_UserID含義<例如：用戶名。>用戶ID數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_UserName含義<例如：用戶名。>用戶昵稱數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_Password含義<例如：用戶名。>用戶密碼數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_Popedom含義<例如：用戶名。>用戶權(quán)限數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>m_Remark含義<例如：用戶名。>保存?zhèn)渥?shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>public修飾符<例如：無。>初始值<例如：null。>方法voidCAddUser::OnAddUser()功能描述顯示“查找/添加用戶”對話框，根據(jù)用戶設(shè)定的用戶帳號(hào)、昵稱等信息或者查找到的用戶信息，在數(shù)據(jù)庫中新增一條用戶記錄。以后在用戶的好友列表中就會(huì)顯示新增的好友。訪問類型<例如：private。>private修飾符<例如：static。>輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說明,包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>算法與處理流程<要求：說明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對程序的注釋。規(guī)定對信息是否有特殊的編碼要求。>1、聲明一個(gè)CUser對象2、聲明一個(gè)CUserManage對象3、調(diào)用CUser對象的SetUserID(CStringm_UserID)等方法將輸入的用戶新增信息保存到CUser對象的各個(gè)成員變量中；4、使用一個(gè)if語句調(diào)用CUserManage對象的IsExist(CStringm_UserID)方法檢驗(yàn)輸入的用戶信息是否有效，有效的話，彈出一個(gè)MessageBox()對話框，詢問用戶是否添加新用戶，確定的話執(zhí)行就調(diào)用CUserManage對象的AddUser(CUseruser)方法添加一個(gè)新用戶，否則不做任何修改輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>返回<要求：說明返回值的含義。>CDelUser描述<要求：簡述此類下列相關(guān)內(nèi)容：實(shí)現(xiàn)功能在模塊中起到的作用引用此類應(yīng)注意的事項(xiàng)。>引用包列表或頭文件<要求：簡述此類下列相關(guān)內(nèi)容：例如：java.util.Vectorcom.ztenc.xxx。>繼承（實(shí)現(xiàn)）關(guān)系<要求：繼承（實(shí)現(xiàn)）的類（接口）的包的完整路徑。例如：java.util.Vector>屬性<要求：描述屬性名稱、含義、數(shù)據(jù)類型、訪問類型、修飾符以及初始值。>m_UserID含義<例如：用戶名。>用戶ID數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>private修飾符<例如：無。>初始值<例如：null。>m_UserName含義<例如：用戶名。>用戶昵稱數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>private修飾符<例如：無。>初始值<例如：null。>m_Password含義<例如：用戶名。>用戶密碼數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>private修飾符<例如：無。>初始值<例如：null。>m_Popedom含義<例如：用戶名。>用戶權(quán)限數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>private修飾符<例如：無。>初始值<例如：null。>m_UserList含義<例如：用戶名。>列表控件變量數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>private修飾符<例如：無。>初始值<例如：null。>m_Index含義<例如：用戶名。>選定的用戶記錄數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>private修飾符<例如：無。>初始值<例如：null。>m_CUserList含義<例如：用戶名。>保存用戶列表信息數(shù)據(jù)類型<例如：java.lang.String。>訪問類型<例如：private。>private修飾符<例如：無。>初始值<例如：null。>方法voidCDelUser::OnInitDialog()功能描述顯示用戶列表。訪問類型<例如：private。>public修飾符<例如：static。>輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說明,包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>算法與處理流程<要求：說明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對程序的注釋。規(guī)定對信息是否有特殊的編碼要求。>1、聲明一個(gè)CUserManage對象2、調(diào)用CUserManage對象的GetUserList(CArray<CUser,CUser>*UserList)方法獲取數(shù)據(jù)庫里用戶列表3、使用一個(gè)for循環(huán)逐條顯示用戶列表輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>返回<要求：說明返回值的含義。>voidCDelUser::OnClickList(NMHDR*pNMHDR,LRESULT*pResult)功能描述選擇用戶訪問類型<例如：private。>public修飾符<例如：static。>輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說明,包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>算法與處理流程<要求：說明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對程序的注釋。規(guī)定對信息是否有特殊的編碼要求。>1、聲明一個(gè)整型變量m_index，作為一個(gè)索引2、調(diào)用列表控件成員變量m_userlist的GetSelectionMark()方法，獲得在列表中選中的用戶，并將GetSelectionMark()方法的返回值賦給m_index3、調(diào)用列表控件成員變量m_userlist的GetItemText(index,N)方法，將選中的用戶信息保存到輸入框變量中輸出<要求：給出本函數(shù)的輸出參數(shù)的詳細(xì)說明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>返回<要求：說明返回值的含義。>voidCDelUser::OnDelUser()功能描述刪除用戶信息訪問類型<例如：private。>public修飾符<例如：static。>輸入<要求：給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說明,包括取值范圍、含義，及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>算法與處理流程<要求