软件开发规范备忘录.docVIP

目 录 目 录.... 2 1. 用户体验的规范.... 3 1.1. 交互与易用性概述... 3 2. 命名的规范.... 5 2.1. 代码开发中的命名规范... 5 2.2. 数据库开发中的命名规范... 8 3. 编程的规则.... 9 3.1. 错误检查规则... 9 3.2. 大括号规则... 9 3.3. 缩进规则... 9 3.4. 小括号规则... 9 3.5. Case规则... 9 3.6. 对齐规则... 10 3.7. 单语句规则... 10 3.8. 单一功能规则... 10 3.9. 简单功能规则... 10 3.10. 明确条件规则... 10 3.11. 选用FALSE规则... 10 3.12. 独立赋值规则... 11 3.13. 定义常量规则... 11 3.14. 模块化规则... 11 3.15. 交流规则... 11 4. 注释的规范.... 12 4.1. 概述... 12 4.2. 自建代码文件和数据库项注释... 12 4.3. 类注释... 13 4.4. 方法注释... 13 4.5. 代码间注释... 13 4.6. 修改后的注释... 13 参考文献.... 14 1. 用户体验的规范 1.1.交互与易用性概述 1.1.1. 软件的智能和记忆功能 l 用户登录界面最好有用户名和ID的记忆，焦点直接定位到密码输入框 l 单据有哪些信誉好的足球投注网站界面可以保存用户自定义的各种有哪些信誉好的足球投注网站条件组合 l 系统可以根据用户的使用频度对相关功能进行自动的优先级排序 l 系统能够记忆不同用户的使用偏好，使用系统的固有模式和常用的自定义设置 1.1.2. 减少不必要的重复交互 l 减少不必要的各种操作，能够点一次鼠标或敲一次键盘完成的绝不作出两次或多次 l 提示信息要适度，太多不好，太少也不好 l 数据项完整性校验问题要注意光标焦点自动定位到错误处 l 完整业务功能不要让用户在多个窗口切换多次才能够完成。尽量减少这种切换 l 为了方便用户切换窗口，相关的表单最好都作为非模态的形式 l 相同的信息不要让用户在系统中多处或多次录入，保证入口的唯一性 l 系统要尽可能根据用户已经录入信息自动获取其它附属信息，而不需要用户重复的选择录入 1.1.3. 导航和界面跳转 l 表单新弹出对话框，对话框再弹出对话框的这种层次要控制在3层以内。 l 所有的非模态活动窗口最好有类似桌面任务栏一样的停靠方式，方便切换窗口 l 系统可以支持用户自己定义常用功能和菜单 l 对于常用功能应该提供便捷的快捷键和工具栏按钮 l 对于系统中提供的各种业务和表单功能能够让用户便捷挑转到帮助信息上 l 对表单和界面联动和交互的时候要注意相关界面数据的自动刷新 l 一个窗口中最多不要出现超过三个的GRID控件 l BS方式不要左右滚屏。CS模式既要避免左右滚屏也要避免上下滚屏 l 需要根据业务查看需求和数据的展现需求来选择合适的界面控件 1.1.4. 系统性能和健壮性方面 l 系统中相关的耗时操作都必须转变鼠标为等待状态 l 系统耗时操作超过30秒的最好能够提供给用户相关的进度条功能 l 系统耗时功能超过2分钟的最好能够设计为异步多线程的方式进行处理 l 系统应用有友好的完整性和约束校验的提示信息，方便用户修改录入数据 l 在系统出现异常情况下应该有友好的统一的提示信息，同时后台应该记录详细的异常日志 1.1.5. 界面友好性和易用性方面 l 表单应该能够根据屏幕分辨率自动适应。在界面上让用户一次能够看到足够多的信息 l 表单应该支持Tab键功能，顺序为从左到右，从上到下 l 常用的表单应该同时支持键盘操作和鼠标操作 l 界面上控件的布局应该间距适当，标签和控件对齐，有适当的录入提示信息 l 界面的配色应该尽量简单，尽量少使用各种刺眼的颜色 l 用户看到表单后应该就基