文档介绍：PB命名规则及软件开发规范
PB命名规则及软件开发规范2011-01-05 11:34PB命名规则及软件开发规范
软件的编写、维护和测试都是由多人协同完成的,这样在工作中就需要一些约定和规范来协调工作人员的工作。PB虽然吸收了很多RAD工具的优点,但工具只是设施、基础,还需要优秀的方法指导。这就需要我们制定软件书写标准以规范我们的程序开发。使程序具有很好的可读性、可维护性。
下面就pbl库划分、命名规范、注释规范、代码格式规范及界面规范进行约定。
一、应用程序pbl组成(假设应用名为app)
我们将对象进行分门别类存放,以便于查找和管理
1、:存放应用、菜单、公用函数、公用结构。。
2、:存放窗口。
3、:存放数据窗口对象。
4、:存放公用的用户对象(这些对象可以直接移植到其他的项目中使用)。
注:鉴于目前我们PB开发系统状况--【窗口】、【数据窗口对象】都比较多,第2点,3点规范不采纳,我们将对【窗口】、【数据窗口对象】都按系统大菜单的功能来命名pbl并存放在一起。
二、应用程序中对象命名规范
1、窗口命名规范
窗口的名字以w_开头,后面加以描述其功能的英文单词。如w_label表示此窗口为标引窗口。如果A窗口为B窗口(w_label)的弹出窗口,则A窗口应命名为w_label_pop(pop为弹出窗口功能的英文名称)。(注:不做强制要求,直接w_模块功能名也可以)
2、数据窗口对象命名规范
数据窗口对象以d_开头,后面加上作为其数据源的表名。如以表stv_class为数据源建立的数据窗口对象应命名为d_stv_class。如果对d_stv_class进行了修改,如更改其显示风格、增加计算字段或检索参数等,则将其命名为d_winname_label(winname为窗口名,label功能名)。
注:对【数据窗口对象】再详细说明一下,按其功能作用再分命名方式。
报表:d_模块功能名
子报表:dwc_模块功能名
查找条件datawindow:dwf_模块功能名
Windows窗口里:dw_模块功能名
Datastore对象:ds_模块功能名
下拉列表框datawindow:dddw_模块功能名
3、变量命名规范
全局变量命名:以gt_开头,其中t表示数据类型的第一个英文字母,后缀为变量功能名。
依次类推实例变量以it_开头,局部变量以lt_开头。
例如:存储xml文件ip地址的全局变量可定义为:string gs_xmlip。
存储窗口中ddlb当前选择的索引的实例变量可定义为integer ii_index
在dw_1:clicked!中存储dw_1行数的变量可定义为long ll_rownum
注:对于功能意义不大,如做循环用的临时变量i,j等可以直接定义不做额外要求。
4、函数命名规范
全局函数以gf_开头,后缀为能表示其功能的英文名称,如gf_connectdb表示连接数据库的全局函数。
窗口函数以wf_开头,后缀为能表示其功能的英文名称,如wf_insertlb表示往listbox中添加数据。
用户对象中的函数以of_开头,后缀为能表示其功能的英文名称,如
of_