百度文库 - 让每个人平等地提升自我
变量，局部变量，返回值，算法说明，使用约束等。 8.2.1.1.9 限制条件 8.2.1.1.10 其他说明
8.2.2 模块2
模块1主要分为以下几个子模块：子模块1、子模块2和子模块N。 8.2.2.1 子模块1 8.2.2.1.1 设计图
8.2.2.1.2 功能描述
简要描述子模块1的业务功能。 8.2.2.1.3 输入数据
详细描述用户输入的数据(包括任何输入设备)以及这些数据的有效性检验规则。 详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。 8.2.2.1.4 输出数据
详细描述子功能1所产生的数据以及这些数据的表现形式。 8.2.2.1.5 业务算法和流程
从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。 8.2.2.1.6 数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。） 8.2.2.1.7 源程序文件说明
给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能说明，包含的前导文件及函数名称等。 8.2.2.1.8 函数说明
具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全局变量，局部变量，返回值，算法说明，使用约束等。 11
百度文库 - 让每个人平等地提升自我
8.2.2.1.9 限制条件 8.2.2.1.10 其他说明
9. 接口设计
9.1 内部接口 9.2 外部接口 9.2.1 接口说明
例如：xx子系统通过xx从xx子系统取得xx等，相关标准，调用示例，可根据需要增加章节描述接口。 9.2.2 调用方式
例如：内部接口调用： 例: /** *通过用户服务号码取得该客户认证密码等信息，如果该客户存在返回为0，其他情况参考错误编码 */ public RUserInfo getUserInfo (String userNo); 10. 数据库设计
详见[xxx数据库设计说明书] 如果数据库设计内容比较少，则直接在此处描述。 11. 系统安全保密设计
11.1 说明
例如：由于存在与外部系统的接口,所以需要考虑访问安全的问题. 11.2 设计
例如：分为数据传输部分,IP过滤部分,身份验证部分.[章节可补充] 12
百度文库 - 让每个人平等地提升自我
11.2.1 数据传输部分
例如：在部分数据传递的时候,考虑以https协议,需要在部署的时候作相关处理. 11.2.2 IP过滤分部
例如：可在系统前端通过Filter实现,该Filter实现对该地址访问的IP过滤作用.可信任IP地址通过xml文件进行配置. 11.2.3 身份验证部分
例如：对信任的用户,颁发身份验证码,通过该标识进行身份识别.
12. 系统性能设计
13. 系统出错处理
例如：为了在系统出现异常情况下给用户以明确的提示，可采用两种方式予以提示： 1．使用Javascript的alert()函数直接提示，这主要在输入或修改的情况下使用； 2．使用统一的错误界面提示，该界面对应于页面。错误界面样式如下图所示： 错误提示:“错误提示内容”返回 错误提示界面
13
百度文库 - 让每个人平等地提升自我
14. 设计和开发规范
【可以列表方式列出设计开发的参考文档的索引，内容较少/关键内容可以章节方式填写】
14.1 数据库设计规范
【参见《XXXX数据库设计规范》】
14.2 .NET编码规范
特别强调：
? 详细请参见《文档规范》
? 这里只做简单阐述，如有变动，会及时同事整个项目组相关人员。
(1) 不要给类名加前缀。使用PascalCasing风格，不使用匈牙利命名法 。 (2) 要用名词词组来给类型命名。使用PascalCasing风格 。 (3) 类名少用缩写,不要使用下划线字符 (_)。 (4) 基类CBase的文件名为：;
(5) 泛型类命名：考虑用T来命名参数类型 ，类如：public class List
(7) 枚举命名：以复数结尾，表明这是一个枚举，例如：Enum ColorButtons (8) 结构命名：表明这是一个结构体，例如：Structure CustomerInfoRecord '以Record结尾
? 除使用工具直接生成的类外，其它所有类的功能要有注释，即使只是一个数据对象；
非常见功能的API必须要有功能描述的注释。独立的要被应用其他功能所调用的
14
百度文库 - 让每个人平等地提升自我
模块的接口和公共API的注释要完备，即包括功能说明、参数和返回值说明。其它情况的API的注释尽量完备，但不强制要求。
? 一次性的流打开后必须关闭和释放。一般地，在流打开后，都有一个try catch语
句，务必加上finally块释放流资源。
? 即使IF，While是单语句，也要使用“{ }”来划分程序块。
? 不要有完全为调试使用的日志信息，如(“1”)；如要使用，在调试完成后请及时
删除。
? 一些常识性代码，不需要写没必要的注释。 ? 不要用工具生成没用的注释。
14.3 代码目录结构
系统架构目录结构设计图,如下：
15
软件详细设计文档模板(最全面)
