程序中的各个函数, 包括函数名称及其所在文件, 功能, 格式, 参数, 全局变量,局部变量,返回值,算法说明,使用约束等。 3.2.2.1.9 限制条件 3.2.2.1.10 其他说明 4.接口设计 4.1 内部接口 4.2 外部接口 4.2.1 接口说明例如: xx 子系统通过 xx从 xx 子系统取得 xx等, 相关标准, 调用示例, 可根据需要增加章节描述接口。 4.2.2 调用方式例如:内部接口调用: 例: /** * 通过用户服务号码取得该客户认证密码等信息,如果该客户存在返回为 0 ,其他情况参考错误编码*/ public RUserInfo getUserInfo (String userNo); 5.数据库设计详见[xxx 数据库设计说明书] 如果数据库设计内容比较少,则直接在此处描述。 6.系统安全保密设计 6.1 说明例如:由于存在与外部系统的接口, 所以需要考虑访问安全的问题. 6.2 设计例如:分为数据传输部分,IP 过滤部分, 身份验证部分.[ 章节可补充] 6.2.1 数据传输部分例如:在部分数据传递的时候, 考虑以 https 协议, 需要在部署的时候作相关处理. 6.2.2 IP 过滤分部例如:可在系统前端通过 Filter 实现,该 Filter 实现对该地址访问的 IP 过滤作用.可信任 IP 地址通过 xml 文件进行配置. 6.2.3 身份验证部分例如:对信任的用户, 颁发身份验证码, 通过该标识进行身份识别. 7.系统性能设计 8.系统出错处理例如:为了在系统出现异常情况下给用户以明确的提示,可采用两种方式予以提示: 1 .使用 Javascript 的 alert() 函数直接提示,这主要在输入或修改的情况下使用; 2 .使用统一的错误界面提示,该界面对应于 errorpage.jsp 页面。错误界面样式如下图所示: 错误提示界面
全文预览
