"PB编程规范"
PB编程规范是指导开发者使用PowerBuilder进行软件开发时的一套标准规则,旨在提高代码质量,提升团队协作效率,并确保代码的可读性和可维护性。这一规范涵盖了编程对象的分类与组织、版本管理和对象命名等多个方面。
1. 编程对象的分类
- 源代码: 包括PBL库、函数库、事件处理等,是程序的核心部分。
- 可执行代码: 编译后的应用程序或项目文件,供用户运行。
- 资源文件: 如.pbr (PowerBuilder资源)、.bmp (位图)、.ico (图标) 文件,用于提供界面元素和图形资源。
- 配置文件: 如.ini文件,用于存储应用程序的配置设置。
- 其他: 可能包括文档、数据库连接文件等辅助资源。
2. 编程对象的组织
- 源代码: 应该根据子系统组织在SrcCode目录下,可以进一步细分到如pbl子目录。
- 可执行代码: 存放在Program或项目名称目录下,同样可按子系统分目录。
- 图片文件: 放置于Images或pic目录中,用于存放各种图像资源。
- 配置文件: 通常放在Ini目录下,方便管理和查找。
- 其他: 其他类型的文件可以归类在Other目录下,以便统一管理。
3. 版本说明
- 版本号A.B遵循特定的标准,A和B都是0到99之间的数字。
- 开发阶段的版本(A>1且B为奇数),标记为"开发版"。
- B为偶数时,表示"稳定版",意味着软件功能完备,可实际运行。
- 开始开发时,版本号为0.1,随着开发进度逐步升至0.99。
- 当软件达到内部测试标准,发布1.0BetaX版本,X代表测试次数。
- 经过用户测试,稳定运行的版本标记为1.0RC,意味着可以投入实际应用。
- 最终稳定版本标记为1.0,可用于推广和广泛应用。
- 功能小幅度改进时,次版本号B增加;大改动时,主版本号A增加。
4. 对象命名规范
- 部件名称建议不超过40个字符,采用"A_B"的结构。
- A部分为部件类型前缀,例如控件类型或功能模块。
- "_"作为分隔符。
- B部分详细描述部件名称,推荐采用"功能代码_功能描述"的方式,以清晰明了地表达部件的作用。
- 对于关键变量,其命名应当具有明确含义,易于理解。
通过遵循这些规范,开发者能够创建出结构清晰、易于维护的PB应用程序,同时也有助于团队间的沟通和代码审查。在实际开发中,应结合团队习惯和项目需求适当调整规范,以实现最佳的开发效果。