PB通用的编程规范

[PB]-PB编码规范

**综述

*编程对象的分类
以PowerBuilder作为前台开发工具，进行软件开发的过程中，所涉及的编程对象如下所示
序号 类别
1 源代码
2 可执行代码
3 资源文件（如pbr，bmp，ico文件）
4 配置文件（如ini文件）
5 其他

*编程对象的组织
使用PowerBuilder开发工具产生的对象，可以按照设计（正在编写和调试）和运行（调试、编译结束，可以接受测试和运行）中的状态进行编程对象的组织规划，重点是目录结构的划分，具体目录的相对关系如下所示
类别 目录 说明
源代码 SrcCode 可按子系统再划分子目录（如pbl等文件夹）
可执行代码 Program或项目名称 可按子系统再划分子目录
图片文件 Images或pic等 包含应用图标ICO文件、BMP/JPG/GIF文件
配置文件 Ini
其他 Other

**版本说明
a. 软件版本号标准为A . B，其中A和B为0到99之间的数字。
b. 当A大于1并且B为奇数时，表示当前版本为处于开发、测试阶段的版本，定义为“开发版”；当B为偶数时，表示当前版本为稳定的、可实际运行的版本，定义为“稳定版”。
c. 当软件开始开发时，确定版本号为0.1；随着软件开发的进度，版本号随着每一次主要功能的完善而变化，最高达到0.99。
d. 软件初步开发完成后，经过软件开发小组内部测试，初步能够完成软件需求提出的业务规范和技术要求，软件基本能正常运行，此时，确定该软件版本号为1.0 Beta X ，这意味着软件可以投入实际应用测试，其中X代表测试的次数。
e. 当软件的1.0 Beta X 版本推出并经过用户实际应用或者试运行测试后，此时，确定该软件版本号为1.0 RC。这意味着软件可以投入实际应用运行。
f. 当软件的1.0 RC 版本投入实际应用运行达到某一时限后，则认为该版本已经稳定，可以完全正常地使用了，这时，确定软件的版本号为1.0，这意味着软件开发完成，可以投入实际应用和推广。
g. 当软件进行升级时，如果功能变化不大，则次版本号变化；如果软件功能发生重大变化时，主版本号变化。


**对象命名规范

*命名约定
a.部件名称可以达到40个字符，组成方式为A_B。
b.A部分表示前缀，表示部件的类型。
c.紧跟着一条下划线“_”。
d.B部分描述此部件的名称。可以根据情况具体决定B的构成。推荐将B部分分解成两部分： 功能代码_功能描述。
e.在重要变量后面写注解表示此变量的用途。
比如，常用的几种对象命名是
窗口的命名：w_功能代码_功能描述。
数据窗口控件的命名：dw_功能代码_功能描述。
数据窗口对象的命名：d_功能代码_功能描述。
菜单命名：m_功能代码_功能描述。
用户对象：uo_功能代码_功能描述。

*具体命名规则

1. 函数的命名规则
函数名=‘函数适用范围代码’ +‘f’+‘_’+‘函数功能描述’，其中函数的
适用范围代码和意义如下：
g 全局函数；
w 窗口函数；
m 菜单函数；
u 用户对象函数。
例：检查SQL语句执行结果的全局用户函数命名如下：gf_checksql()。

2. 应用
应用的命名应使用与该应用的意义相关联的英文字母，例如，app_si表示社会保险应用系统。

3. PBL库
PBL库组织的好坏很重要，它会影响应用开发和维护的容易程度以及应用的性能。Library的组织应遵循以下原则：
a. Library的大小。PowerBuilder对Library的大小没有限制，但最好使之小于1MB，Library太大，PowerBuilder要花更多的时间去打开和存储对象，这会影响开发的效率。
b. Library的数量。尽量用最少的Library数量。应在Library的数量和每个Library中对象数量之间找到平衡点，如果Library数量太多而每个Library中对象数量太少，搜索路径会太长，影响运行效率。
c. Library的优化。要在Library画笔中经常对Library进行优化。随着时间的推移，Library会被分段，会使Library的存储变得不连续，影响运行效率。
d. Library的分类组织。PBL库可按子系统或功能组织，一般应用都包含公共PBL库。每个PBL库文件命名应该与该文件作用相关联，例如报表PBL库文件命名为report.pbl。每个PBL库文件应该包含详细注释，列出该PBL文件包含哪些对象，对应哪个子系统，与其他PBL（调用）关系等信息。

为了有效地进行团队开发，实现对PB源码的管理，要求基于对各方因素（如应用代码的执行效率和所占存储空间）和维护上的全面考虑，对PB源码实行分类的原则。PowerBuilder的Library的分类原则有两种方式：
（1）制定对象分类法
根据所制定的不同类的对象进行分类。
例：将所有的窗口放在一个Library中。
（2）功能模块分类法
根据系统的功能模块的不同，将属于不同类的制定对象放在一个Library中。这是一种更为有效的方式。

4. 初始化配置文件
初始化配置文件的命名必须与应用的名称一致，扩展名为.ini，例如：si.ini。用户的可变环境信息都应该保存在该文件中，关键信息加密保存，并且提供管理工具，而不是手工修改该文件。

5. 资源文件
资源文件的命名必须与应用的名称一致，扩展名为.pbr，例如：si.pbr。

6. 窗口
窗口的命名必须以w（Window的首字符）开头，加下划线（_），其后紧接与窗口意义相关联的英文字母（总长不得超过PowerBuilder的40个字符限制），并且在注释（Comments） 框内写出该窗口的作用（中文或英文），如下所示。
序号 窗口名称 Comments
1 w_about 关于本系统的版权信息
2 w_system_error 系统出错提示
3 w_main 系统主界面
4 w_report_sheet 报表输出

7. 数据窗口
普通数据窗口的命名必须以dW（DataWindow缩写）开头，代码表下拉式子数据窗口必须以dddw（DropDownDataWindow缩写）开头，加下划线（_），其后紧接与数据窗口意义相关联的英文字母（总长不得超过PowerBuilder的40个字符限制），并且在Comments 框内写出该数据窗口的作用（中文或英文），如下所示。
序号 数据窗口名称 Comments
1 d_system_error 显示系统错误，被w_System_Error窗口调用
2 d_categories 对产品分类，被w_Report_Sheet窗口调用
3 d_detail_parts Parts of Products Described in Detail
4 d_detail_function Products Function Described in Detail
5 dddw_sex 性别代码表

8. 菜单
菜单的命名必须以 m（Menu缩写）开头，加下划线（_），其后紧接与菜单意义相关联的英文字母（总长不得超过PowerBuilder的40个字符限制），并且在Comments 框内写出该菜单的作用（中文或英文），如下所示。
序号 菜单名称 Comments
1 m_main Front End Main Menu
2 m_report Report Subsystem Menu<