xx軟件系統(tǒng)設計說明書-資料下載頁
2025-07-21 15:42本頁面
【正文】 ype of the module, for example, the module in Level 2 Design, the process in Level 1 Design, etc.Function Description: Describing the functions of the module in brief, which should be consistent with the related section of the HLD documents.Function Invoking Relation: Using the Hierarchy Chart or Structure Chart to describe it, for example:本節(jié)應按照下列格式進行描述：標識：模塊名稱類型：模塊類型，如，2級設計中的模塊，1級設計中的進程功能概述：簡要描述本模塊功能，要和概要設計文檔中相關模塊分解的描述一致。函數(shù)調用關系: 用層次圖或結構圖的方式描述函數(shù)調用關系，如：圖1 Module 1 Structure Chart 模塊1結構圖 Function 1 函數(shù)1 Descript the function as follows。 Function: // name of function Description: // functionality of the function Calls: // function lists which called by this function Data Accessed: // global variables or database tables to be visited Data Updated: // global variables or database tables to be modified Input: // description of each input parameter, // including function description、value description， // and relationships of the parameters Output: // description of output parameter Return: // description of return value Others: // other descriptionsImplement: pseudo code or flow chart can be used here 用以下格式描述函數(shù) Function: // 函數(shù)名稱 Description: // 函數(shù)功能、性能等的描述 Calls: // 被本函數(shù)調用的函數(shù)清單 Data Accessed: // 被訪問的全局變量和數(shù)據(jù)庫表 Data Updated: // 被修改的全局變量和數(shù)據(jù)庫表 Input: // 輸入?yún)?shù)說明，包括每個參數(shù)的作用、取值說明及參數(shù)間關系。 Output: // 對輸出參數(shù)的說明。 Return: // 函數(shù)返回值的說明 Others: // 其它說明實現(xiàn)： 這里可以使用偽碼或流程圖例子:m2ua_return_t m2ua_nif_sendto_mtp2/*該函數(shù)重用原來MTP3模塊中提供的向MTP2發(fā)消息的函數(shù)*/if 鏈路號不合法 返回 M2UA_FAILURE，失敗if 消息類型不正確 返回 M2UA_FAILURE ，失敗if 參數(shù)指針為空 返回 M2UA_FAILURE ，失敗調用 消息申請函數(shù)VOS_AllocMsg，為臨時變量pMsg申請消息包空間if 申請消息包失敗 返回 M2UA_FAILURE，消息申請函數(shù)填寫發(fā)送模塊信息到pMsg調用 設備管理的函數(shù)Dev_FromVspCardNoGetCpuid，填寫目的板的CPUIDif 調用失敗 調用 VOS_FreeMsg，釋放pMsg的消息包空間 返回 M2UA_FAILURE，失敗填寫目的功能模塊號到pMsg填上消息包的具體內容調用 消息發(fā)送函數(shù)VOS_SendMsg，VOS把消息包發(fā)送到給MTP2返回 M2UA_SUCCESS，成功 Function 2 函數(shù)2 Module 2 Detail Design 模塊2詳細設計 Error Process 錯誤處理 System Error 系統(tǒng)錯誤Describes how the errors, such as memory allocation failure, task creation failure, to be processed.描述象內存分配失敗，任務創(chuàng)建失敗等錯誤是如何被處理的。 Interface Error 接口錯誤Describes the error codes to be generated for the external entities描述將要產生并給外部實體用的錯誤碼 Protocol Error 協(xié)議錯誤Describes how to handle the errors not mentioned in the protocols. (Optional)描述在協(xié)議中沒有描述的情況如何處理。（可選）15
黨政相關相關推薦
鄂ICP備17016276號-1