PB软件设计技术规范
(修订本)
1 软件界面风格
1.1 窗口
1主界面
采用巨龙定制的标准的“管理信息系统”程序主界面。 2 分辨率
程序窗口设计的分辨率为800*600或640*480,窗口高宽比例应该与屏幕的比例一致。 3窗口模式
分清有模式窗口(对话框)和无模式窗口(对话框)。有模式窗口(对话框)在应用程序继续之前必须由用户关闭;无模式窗口(对话框)允许用户在不取消或不移去窗口(对话框)的情况下,显示并返回到另一任务。 4窗口标题
应能反映该窗口的功能的简单概括性文字,不能太长。 5颜色
窗口的背景颜色使用巨龙指定背景或微软缺省颜色。 6字体
在Window 95中开发推荐使用宋体9号,在window NT中开发推荐使用宋体 9号; 7控件
控件位置摆放适当,特别是按钮位置摆放(上、下等),数据窗是否允许横滚动条出现,数据窗对象颜色设置,字段颜色和状态。录入、修改数据窗对象中非空字段和不允许获得焦点字段的体现。适当形象图形的使用。 ①常用按钮名称的统一规定:
新增、保存、修改、条件、查询、打印、打证、照片、浏览、确定、取消、复位、关闭、退出、返回、预览、打印设置、前翻、后翻 ?? ②业务操作按钮
按扭的命名简洁,形象。 8方便用户
录入界面要考虑用户录入的方便,要求能使用回车键、TAB键在单元格间行进; 考虑ESC,RETURN键的缺省实现。 9提示信息
窗口状态条和TAG、Microhelp 提示信息。
1.2 菜单标准
①如果菜单命令在被执行之前还需要其他信息,例如:弹出其他对话框,那么,应该在菜单标题后面加上省略号,例如:另存为(A)…。
②所有的菜单都应该有键盘访问入口,同一层菜单不应有重复的键盘访问入口; ③最好只有两层菜单,多于一层子菜单的情况可以考虑用对话框代替; ④菜单名称中文在前,英文字母在后,并带括弧和下划线。
1.3 工具栏
工具栏应可移动;功能相关的应绑定成组。
1.4 图标
系统图标、收集定作
1.5 字符串
统一的快捷键,一致的提示信息(包括错误处理)。
1.6 输出
(1)全系统有明确的使用、信息、出错提示;
(2)用户的查询、统计结果分为屏幕显示和打印输出,屏幕显示要求数据足够详实,打印输出要求可由用户调整输出数据项,还可定制打印输出格式; (3)打印:如整张报表为空(没有记录)则不进行打印;
(4)只要存在一个输入或查询DATAWINDOW,均应有打印功能。
1.7 其他
(1)标准的About(关于)对话框,Splash对话框,口令验证对话框; (2)最大化按钮必须确有放大作用,关闭按钮仅作为缺省或备用方式,另在窗
体中应有“确认”或“取消”或“关闭”按钮;
(3)反馈给用户的说明文字的要求:避免使用计算机用语、消息限制在2-3行内、避免用责怪用户的措辞、多行消息的文本左对齐、避免在说明文字中出现错别字;
(4)帮助菜单中加入“关于(A)”项;
(5)删除记录时提示:“是否要删除 ? ”, 选择“是”,“否”;
(6)如有修改记录将要退出时或要进入查询条件输入状态时均要提示“是否要保存”,选择: “是”,“否”,“取消”;
(7)对重要操作如初始化, 计算等影响面大的要提示:“操作...[后果],是否进行操作? ”,选择 “是”,“否”;
(8)对键盘的支持:友好的用户界面应有很好的键盘支持,应用程序应该支持常用的键盘操作。所有菜单上的命令都是可以通过键盘来访问; (9)所有的WINDOW均应有标题,标题内容为当前处理内容;
2 软件编码规范
程序设计的标准是结构清晰,可读性好,这样可便于测试和排除程序故障,能够有效地在开发期间消除绝大多数在程序中掩藏的故障,大大提高软件的可靠性,另外可方便对他进行修改、扩充和移植,程序的可维护性好。
2.1.基本命名法则
使用统一编码约定集的主要原因,是使应用程序的结构和编码风格标准化,以便于阅读和理解这段编码。好的编码约定可使源代码严谨、可读性强且意义清楚,与其它语言约定相一致,并且尽可能的直观。PB应用程序中的命名标准主要分为三个方面:控件命名标准,变量命名标准以及函数(过程)命名标准。在 PB代码中声明的过程、变量和常数的名字,必须遵循以下这些规则:
■
它们必须以字母开头。
它们不可以包含嵌入的句号或者类型声明字符(规定数据类型的特殊字符)。 它们不能超过 255 个字符。控件、窗体、类和模块的名字不能超过 40 个字符。 它们不能和受到限制的关键字同名。
■
■
■
受到限制的关键字是PB使用的词,是语言的组成部分。其中包括预定义语句(比
如 If 和 Loop)、函数(比如 Len 和 Abs)和操作符(比如 Or 和 Mod)。
2.2 常量及变量命名原则
■ 变量应该总是被定义在尽可能小的范围内。在 PB的应用程序中,只有当没有其它方便途径在窗体之间共享数据时才使用全局变量。
■ 当必须使用全局变量时,在一个单一模块中声明它们,并按功能分组。给这个模块取一个有意义的名称,以指明它的作用。
■ 常量及变量的命名规则为:变量范围前缀+对象或变量数据类型+变量(常量)名主体。
■ 在程序中,所有的变量都应该声明。
■ 常(变)量名使用缩略语时,要确保它们在整个应用程序中的一致性。在一个工程中,如果一会儿使用 Cnt,一会儿使用Count,将导致不必要的混淆。 2.2.1 变量范围前缀
下表列出所有PB语言的变量范围修饰符:
变量范围 Global Share Instance Local Argument 前缀 G S I L A 2.2.2 变量数据类型
数据类型 Any Blob Boolean Char Character Date Date Time Dec Decimal Double Int Integer Long Real String Time Unit Ulong UnsignedInt Unsignedinteger 前缀 A Blb B Ch Ch D Dt Dec Dec Dbl I I L R S T Ui Ul Ui Ui Unsigned Long Powerobject Ul po
2.2.3 常(变)量名主体
常(变)量名的主体是大小写混合的,每个单词的首字母大写,要求能反映常(变)量的意义,而且变量名应该是“动宾结构”。例如: li_UserListMax
'对用户列表的最大限制 '(整数值,本地到模块) '新行字符
'(字符串,应用程序全局使用)
gs_NewLine
给常量分组:变量和定义的常量应该按功能分组,而不是分散到单独区域或特定文件中。PB变量命名由该变量被访问的范围和数据类型组合成前缀。
2.3 函数及过程名的命名约定
函数及过程名的命名基本与变量的主体名一样,另外除了全局变量(应该是不被传递的),过程和函数应该仅对传递给它们的对象操作。在过程中使用的全局变量应该在过程起始处的声明部分中标识出来。此外,应该用 ByVal 将参数传递给过程及函数,除非明显地需要改变已传递的参数值。
2.4 对象(含控件)编码约定
为了容易识别不同的对象类型,建议使用一致的对象前缀命名对象。 窗口控件命名:
以PB提供的缺省名为前缀,加上该控件的具体操作含义命名。如: cbx_draf、cb_ok、dw_data、ddlb_agents、ddplb_orders、em_phone等等。 标准类前缀
标准类 Connection ContextInformation ContextKeyWord Datastore DynamicStagingArea DynamicDescriptionArea Error Inet InterResult MailSession Message 命名前缀 Cn Ci Ckw Ds Dsa Dda Err Ient Ir Ms Msg