软件开发规范备忘录

《软件开发规范备忘录》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、1.用户体验的规范…・31.1.交互与易用性概述...32.命名的规范.…52.1.代码开发屮的命名规范…52.2.数据库开发中的命名规范…83.编程的规则....93.1.错误检查规则…93.2.大插号规则…93.3.缩进规则…93.4.小括号规则...93.5.Case规则…936对齐规则…103.7.单语句规则…1038单一功能规则…1()3.9.简单功能规则…103.10.明确条件规则…103.11.选用FALSE规则…103.12.独立赋值规则...113.13.定义常量规则…113.14.模块化规则…113.15.交流规则…114.注释的规范....124.

2、1.概述…124.2.A建代码文件和数据库项注释…4.3.类注释…134.4.方法注释…134.5.代码间注释…134.6.修改后的注释…13目录....212参考文献….141.用户体验的规范1.1.交互与易用性概述1.1.1.软件的智能和记忆功能1用户登录界面最好有用户名和ID的记忆，焦点直接定位到密码输入框1单据搜索界面可以保存用户自定义的各种搜索条件组合1系统可以根据用户的使用频度对相关功能进行自动的优先级排序1系统能够记忆不同用户的使用偏好，使用系统的固有模式和常用的自定义设置1.1.2.减少不必要的重复交互1减少不必要的各种操作，能够点一次鼠标或敲一次键盘完

3、成的绝不作出两次或多次11提示信息要适度，太多不好，太少也不好数据项完整性校验问题要注意光标焦点自动定位到错误处1111完整业务功能不要让用户在多个窗口切换多次才能够完成。尽量减少这种切换为了方便用户切换窗口，相关的表单最好都作为非模态的形式相同的信息不要让用户在系统中多处或多次录入，保证入口的唯一性系统要尽可能根据用八已经录入信息自动获取其它附属信息，而不需要用八重复的选择录入1.1.3.1111导航和界面跳转表单新弹出对话框，对话框再弹出对话框的这种层次要控制在3层以内。所有的非模态活动窗口最好有类似桌面任务栏一样的停靠方式，方便切换窗口系统可以支持用户自己定义常用

4、功能和菜单对于常用功能应该提供便捷的快捷键和工具栏按钮11111对于系统中提供的各种业务和表单功能能够让用户便捷挑转到帮助信息上对表单和界面联动和交互的时候要注意相关界面数据的口动刷新一个窗口中最多不要出现超过三个的GRID控件BS方式不要左右滚屏。CS模式既要避免左右滚屏也要避免上下滚屏需要根据业务查看需求和数据的展现需求来选择合适的界面控件1.1.4.1111系统性能和健壮性方面系统中相关的耗时操作都必须转变鼠标为等待状态系统耗时操作超过3()秒的最好能够提供给用户相关的进度条功能系统耗时功能超过2分钟的最好能够设计为异步多线程的方式进行处理系统应用有友好的完整性和

5、约束校验的提示信息，方便用户修改录入数据1异常口志1.1.5.1在系统出现异常情况下应该有友好的统一的提示信息，同时后台应该记录详细的界面友好性和易用性方面表单应该能够根据屏幕分辨率自动适应。在界面上让用户一次能够看到足够多的信息11111表单应该支持Tab键功能，顺序为从左到右，从上到下常用的表单应该同时支持键盘操作和鼠标操作界面上控件的布局应该间距适当，标签和控件对齐，有适当的录入提示信息界面的配色应该尽量简单，尽量少使用各种刺眼的颜色用户看到表单后应该就基本清楚相关功能，表单要尽量自我解释，不要设计过多的隐含在界面里面功能1.1.6.111数据的录入和检索根据业务

6、需要选择适合的数据录入控件数据录入控件应该有完备的数据完整性和一致性校验功能系统应该提供用户暂吋保存录入数据的功能1111rfi*能够自动获取数据不要让用户再去录入，能够选择录入数据不要让用户手工录入数据检索条件应该适中，不应太多也不应太少。检索支持组合条件检索为了满足不同需求检索可以提供简单检索和高级检索多种方式应该在第一时间提供给用八检索数据，因此检索功能存在性能问题时候要考虑分贝1在检索功能较耗时的时候应该提供给用户相关的进度条显示进度1.命名的规范1所有命名建议釆用驼峰式命名规则，即利用大小写來区分内容;1尽量避免采用缩写的形式，除非是已经被公认的缩写；I所有的

7、命名都必须是英文单词，禁止使用拼音。1.1.代码开发中的命名规范1.1.1.变量的命名［变量作用范围］+［数据类型］+［有具体含义的名称（名词组合）］（+［序号］）变量作用范围是变量在多大范围内存在：全局变量-被多个类所使用，为了避免相关性所引起的修改错误，必须对全局变量着重指出，这里采用“gj'指出。1类变量-在一个类的范围内被使用，跨多个过程（函数），用指出。1过程变量-仅在过程（函数）中生存，不必着重指出。数据类型是指该变暈是什么类型的数据，如整型，长整型，字符串等，都必须在变暈名前标出，一律采用小写字母，如int,lng,dat等