提升PB项目质量:编码与命名规范详解
需积分: 9 186 浏览量
更新于2024-09-16
收藏 110KB DOC 举报
PB开发规范是针对POWERBUILDER编程的一种最佳实践指南,旨在提升项目的代码质量和可读性。该规范详细列出了编码风格、命名约定和组织结构,以便开发人员遵循一致的标准进行编程。
1. 代码风格与格式:
- 在PB代码中,运算符和赋值动词(如“=”)前后需加空格,以提高可读性。例如,正确的写法是 `wf_GetAttrib(id, name, date)`,而不是`wf_GetAttrib(id,name,date)`。
- 使用TAB键进行缩进,而不是空格,以清晰地表示代码块之间的层次关系。这有助于在查看复杂的循环或嵌套结构时更易于理解。
- 函数名、事件名和变量名应采用英文,首字母大写,单词间无下划线分隔。例如,`wf_RightTrim()` 是推荐的命名方式。
- 数据库命令和保留字使用首字母大写,如 `Insert` 和 `Select`。
- 对于较长的语句,推荐使用多行格式,如 `If n_Rows > 6 then dw_report.Retrieve() EndIf`,以增强可维护性。
2. 注释和文档:
- 代码中应包含详细的注释,包括编写日期、编写人、描述、参数、返回值、修改记录等,以便其他开发者了解函数或事件的功能、用途和修改历史。如:
```
//==============================================
// 编写日期:2011-11-21
// 编写人:某某某
// 描述:根据订单ID获取订单详情
// 参数:Ag1 - 订单ID
// Ag2 - 查询结果集
// 返回值:成功获取数据则返回true,否则false
// 修改日期:2011-11-22
// 修改人:某某某
// 修改说明:修复了一个SQL查询错误
//==============================================
```
3. 对象命名规则:
- PBL库的命名应遵循项目缩写(PPP)和内容相关的四字母缩写(OOOO),如 `PPP_Order_EntryLib`。
- 不同类型的PB对象有特定的命名前缀,例如,窗口对象以 `w_` 开头,菜单函数以 `mf_` 开始。
通过遵循这些规范,可以确保PB代码的一致性和可维护性,降低沟通成本,提高团队协作效率,同时也有助于未来项目的长期发展和维护。
2021-10-01 上传
2008-10-28 上传
点击了解资源详情
2016-02-24 上传
2014-07-29 上传
2013-07-26 上传
2010-12-30 上传
2009-03-11 上传
2010-06-18 上传
bear_79
- 粉丝: 24
- 资源: 2
最新资源
- MATLAB新功能:Multi-frame ViewRGB制作彩色图阴影
- XKCD Substitutions 3-crx插件:创新的网页文字替换工具
- Python实现8位等离子效果开源项目plasma.py解读
- 维护商店移动应用:基于PhoneGap的移动API应用
- Laravel-Admin的Redis Manager扩展使用教程
- Jekyll代理主题使用指南及文件结构解析
- cPanel中PHP多版本插件的安装与配置指南
- 深入探讨React和Typescript在Alias kopio游戏中的应用
- node.js OSC服务器实现:Gibber消息转换技术解析
- 体验最新升级版的mdbootstrap pro 6.1.0组件库
- 超市盘点过机系统实现与delphi应用
- Boogle: 探索 Python 编程的 Boggle 仿制品
- C++实现的Physics2D简易2D物理模拟
- 傅里叶级数在分数阶微分积分计算中的应用与实现
- Windows Phone与PhoneGap应用隔离存储文件访问方法
- iso8601-interval-recurrence:掌握ISO8601日期范围与重复间隔检查