内容发布更新时间 : 2024/11/18 16:24:34星期一 下面是文章的全部内容请认真阅读。
XX Low Level Design Specification
?? XX 详细设计说明书 XX Low Level Design Specification
XX 详细设计说明书
Keywords 关键词:能够体现文档描述内容主要方面的词汇。 Words that will reflect main
contents of the document.
Abstract 摘 要:
List of abbreviations 缩略语清单:对本文所用缩略语进行说明,要求提供每个缩略语的英文全名和中文解释。 Describe abbreviations in this document, full spelling of the
abbreviation and Chinese explanation should be provided.
All rights reserved 版权所有,侵权必究
Page 5 , Total 10 第5页,共10页
XX Low Level Design Specification
?? XX 详细设计说明书 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 data i.e. global variable or constant within the module; complex data i.e. class or structure ....
描述模块中定义和使用的数据,包括: 简单数据,如模块级的全局变量、常量; 复合数据,如模块内部的类、结构,...;
2.1.1 Data Description 数据描述
describe simple variables and constant of the module in section 2.1.1.1; describe complex data from section 2.1.1.2, such as class、structure;
在2.1.1.1中描述本模块中的简单变量、常量;
从2.1.1.2起描述本模块中的复合数据,如类、结构等;
2.1.1.1 Simple Data Description 简单数据描述;
All rights reserved 版权所有,侵权必究
Page 6 , Total 10 第6页,共10页
XX Low Level Design Specification
?? XX 详细设计说明书 describe simple variables、constant used or defined in this module;
描述在本模块中定义和使用的简单变量、常量;
2.1.1.2 Structure 1 or Class 1 结构1或类1
define and describe the Data structure;
定义和说明该数据结构;
2.1.1.3 Structure 2 or Class 2 结构2或类2
All rights reserved 版权所有,侵权必究
第7页,共10页 Page 7 , Total 10
XX Low Level Design Specification
?? XX 详细设计说明书 2.1.2 Function Description 函数描述
Describe the relationships of the functions within Module
描述模块内函数的调用关系
2.1.2.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 Called By: // function lists which call this funciton Table Accessed: // tables to be visited
// (only for programm which involved with operation about database) Table Updated: // tables to be modified
// (only for programm which involved with operation about database) 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: pseudocode or flow chart can be used here
用以下格式描述函数 Function: // 函数名称
Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序) Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序) Input: // 输入参数说明,包括每个参数的作用、取值说明及参数间关系。
Output: // 对输出参数的说明。 Return: // 函数返回值的说明
All rights reserved 版权所有,侵权必究
Page 8 , Total 10 第8页,共10页