[华为软件详细设计模板]
List of abbreviations 缩略语清单：对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。Describe abbreviations in this document, full spelling of the abbreviation and Chinese explanation should be provided. Abbreviations缩略语Full spelling 英文全名Chinese explanation 中文解释 1 Introduction 简介 1.1 Purpose 目的To descript the purpose of this document. In general, LLD specification can be used to guide the coding activities directly. 描述本文的目的，一般详细设计必须能够直接指导编码活动。
1.2 Scope 范围This section should address areas which this document includes and that are specifically excludes. 本节应描述文档所包括和不包括的内容。
2 Detailed Design 详细设计This section should focus on the description of the detailed design of the software entities that are a part of the software being described by the HLD Specification。. 对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。
2.1 Module 1 Detail Design 模块1详细设计Describe data that defined or used in the module, including: simple global variable, constant or macro within the module; complex Structure 描述模块中定义和使用的数据，包括：简单数据，如模块级的全局变量、常量、宏；
复合数据，如模块内部的结构、联合...；
2.1.1 Data Description 数据描述Describe simple variables, constant or macro of the module in section 2.1.1.1; Describe complex data from section 2.1.1.2, such as structure, union; 在2.1.1.1中描述本模块中的简单变量、常量、宏；
从2.1.1.2起描述本模块中的复合数据，如结构、联合等；
1. Simple Data Description 简单数据描述describe simple variables、constant or macro used or defined in this module; 描述在本模块中定义和使用的简单变量、常量、宏；
手机app设计模板Describes simple variables, constants used or defined in this module; The description of simple data should follow the format below: Function Description: Describing the usage of the data Data Definition: Defining the data 按照下列格式进行简单数据的描述功能描述：描述该数据的用途数据定义：定义该数据2. Structure 1 结构1 Define and describe the Data structure (include union) 定义和说明该数据结构(包括联合); The description of data structure should follow the format below: Data Structure Description: Describing the usage of the data structure Data Structure Definition: Defining the data structure with the actual programing language Data Items Description: Data Type Data Item Definition Data Item Description 按照下列格式进行数据结构的描述数据结构描述：描述该数据结构的
用途数据结构定义：用实际的编程语言定义该数据结构数据项描述：数据类型数据项定义数据项描述3. Structure 2 结构2 2.1.2 Function Description 函数描述This section should follow the format below: Identification: Title of the module Type: Type 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 in HLD documents. Function Invoking Relation: Using the Hierarchy Chart or Structure Chart to describe it, for example: 本节应按照下列格式进行描述：
标识：模块名称类型：模块类型，如，2级设计中的模块，1级设计中的进程功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。
函数调用关系: 用层次图或结构图的方式描述函数调用关系，如：Figure 1 Module 1 Structure Chart 模块1结构图1. Function 1 函数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 descriptions ----------------------------------
------------------------------------------------------------------ Implement: pseudo code or flow chart can be used here 用以下格式描述函数Function: // 函数名称Description: // 函数功能、性能等的描述Calls: // 被本函数调用的函数清单Data Accessed: // 被访问的全局变量和数据库表Data Updated: // 被修改的全局变量和数据库表Input: // 输入参数说明，包括每个参数的作用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明Others: // 其它说明---------------------------------------------------------------------------------------------------- 实现：
这里可以使用伪码或流程图例子: m2ua_return_t m2ua_nif_sendto_mtp2 /*该函数重用原来MTP3模块中提供的向MTP2发消息的函数*/ if 链路号不合法返回M2UA_*****，失败if 消息类型不正确返回M2UA_***** ，失败if 参数指针为空返回M2UA_***** ，失败调用消息申请函数VOS_AllocMsg，为临时变量pMsg申请消息包空间if 申请消息包失败返回M2UA_*****，消息申请函数填写发送模块信息到pMsg 调用设备管理的函数Dev_FromVspCardNoGetCpuid，填写目的板的CPUID if 调用失败调
用VOS_FreeMsg，释放pMsg的消息包空间返回M2UA_*****，失败填写目的功能模块号到pMsg 填上消息包的具体内容调用消息发送函数VOS_SendMsg，VOS把消息包发送到给MTP2 返回M2UA_*****，成功2. Function 2 函数2 2.2 Module 2 Datail Design 模块2详细设计2.3 Error Process
错误处理2.3.1 System Error 系统错误Describes how the errors, such as memory allocation failure, task creation failure, to be processed. 描述象内存分配失败，任务创建失败等错误是如何被处理的。
2.3.2 Interface Error 接口错误Describes the error codes to be generated for the external entities. 描述将要产生并给外部实体用的错误码2.3.3 Protocol Error 协议错误Describes how to handle the errors not mentioned in the protocols. (Optional) 描述在协议中没有描述的情况如何处理。（可选）List of reference 参考资料清单：Please list referred literature and related documents, format: 请罗列本文档所参考的有关
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论