开发总体设计规.docVIP

开发总体设计规范 本文由lingyijianb贡献 doc文档可能在WAP端浏览体验不佳。建议您优先选择TXT，或下载源文件到本机查看。 2010 总体设计规范 2010 总体设计规范 修订历史记录 日期 版本 作者 说明 2010-1-21 V1.0 Duch,gejm,yangds,luj 2010 总体设计规范 1. 2. 综述 ……3 UI 界面设计规范 ……3 2.1. 2.2. 2.3. 2.4. 风格 ……3 布局 ……3 字体及色彩 ……4 各控件规范 ……4 2.4.1. Label ……4 2.4.2. TextBox……4 2.4.3. Button ……5 2.4.4. 2.4.5. 2.4.6. 2.4.7. 2.4.8. 2.5. CheckBox 和 RadioButton……5 DateTimePicker ……5 ComboBox ……5 GroupBox ……6 ToolTip ……6 UI 参考附件 ……6 存储过程规范……6 3.1.1. 3.1.2. 3.1.3. 3.1.4. 存储过程的注释 ……6 存储过程的异常处理(提高存储过程的健壮性) …… 6 存储过程的错误日志 ……7 存储过程的调试 ……7 3. 数据访问层设计规范 ……6 3.1. 3.2. 3.3. 3.4. 3.5. 3.6. 3.7. 3.8. 3.9. 3.10. 3.11. 3.12. 数据库命名规范 ……8 编辑接口(先图后说明) …… 9 接口名称规范…… 10 接口注释规范…… 13 方法名称规范…… 14 服务实现类 …… 15 业务逻辑实现类 …… 15 日志处理 …… 17 方法颗粒化 …… 17 面向对象思想 …… 17 SQLHelper 数据库连结 …… 17 2010 总体设计规范 1. 综述 1. 为确保新版 SSEIS，界面风格统一、便于以后维护特制定本规范; 2. 为了统一公司软件开发设计过程的 UI 界面设计规范; 3. 使开发人员能很方便的理解每个变量，控件，方法的意义; 4. 为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的 UI 界面设计规范; 5. 为了统一公司软件开发过程中数据访问层的设计编写规范; 6. 本规范还在进一步完善中。 保障约定 1. 研发各小组组长，带头实施本规范，督促检查小组内各研发人员使用本规范。 2. 针对自主产权的控件，各研发小组、各组员，可以提改进建议，不得各自为阵，自建一套。 与本规范不相符合的，测试组视作 BUG 报告。 3. 测试组定期在代码中搜索 MessageBox,发现源码中使用了 MS 的 MessageBox，视作 BUG 报 告。 4. 测试组定期在代码中搜索其他与如下规范相近的控件，发现不符合相，视作 BUG 报表。 5. 开发准备工作完成后，开发人员宣誓，确保规范实施。 范围 1）本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 2. UI 界面设计规范 2.1. 风格 1） 不要设计 Form， 要做 Control， 继承 UserControl， 控件名称以 “ctl” 开头， 设置都与 Windows 默认的一致。 2） 如果要弹出 Form，通过主程序 IMainFrame 中的 IFrameManager 的 CreateForm()来实现。 3） 只有不相干的信息才考虑放到不同的 TabPage 中。 4） 窗体弹出的层数不应超过 3 层。 5） 报错页面的风格一致，统一所有报错页面，以对话框形式友好地提示用户，提示内容必须 具有指导意义，不要擅自用 MessageBox 显示错误信息，用统一的提示信息模块。 6） 鼠标默认显示箭头，若悬浮于链接时状态显示手型；系统忙时显示沙漏形状。 7） 打开新增（修改）页面时，光标初始定位在第一个待输入的文本区、选项框、按钮等。 8） 因输入不正确提示用户重新输入时，光标默认 focus 在出错的输入区，并全选错误输入。 9） 若必填项未填写完毕就提交，应给出说明信息并能自动获得焦点。 10） 可写控件检测到非法输入后应给出说明并能自动获得焦点。 2.2. 布局 1） 界面的容器用 TableLayoutPanel 来约束各控件的位置。 2010 总体设计规范 2） 窗体控件布局和间距尽量与 Windows 标准保持一致，控件和边缘间距为 3;UI 元素采用自上 而下的从左至右的布局。 3） 尽量采用 Dock 和 Anchor 来布