pb程序规范.doc
文本预览下载声明
pb程序规范
一、 书写格式
a.?? 用分层缩进的写法显示嵌套结构的层次。
b.?? 在注释段与程序段，以及不同逻辑的程序段之间插入空行。
c.?? 每行只写一条语句，当需要滚动显示时应该分行书写。
二、 流控制
流控制首先应遵守PowerBuilder语法规范，且用分层缩进的写法突出显示嵌套的层次结构，例如：
For i = 1 To 100
??????? For j = 1 To 50?????
????????????????????? For k = 1 To 200
??????????????????????????????? Matrix[i，j，k]=1
??????????????? Next
??????????? Next
Next
三、注释及格式要求
注释总是加在程序中需要概括性说明或不易令人理解或容易令人理解错的地方。注释语言应简练、易懂而又准确，所采用的语种首选是中文，如有输入困难或特殊需求也可采用英文。
注释原则：
a.?????? 函数或过程的注释
(1)????? 在函数头部必须说明函数的功能和参数（值参、变参）；
(2)????? 在函数的主体部分，如算法复杂时，应以注释的方式对其算法结构做出说明；
(3)????? 函数申请过全局资源且有可能导致资源紧张应加以注明(如内存和文件柄等)；
(4)????? 函数有副作用一定以十分醒目的方式(如加!号等)注明。
b.?????? 语句的注释
(1)????? 应对不易理解的分支条件表达式加注释；
(2)????? 不易理解的循环，应说明出口条件(有GOTO的程序还应说明入口条件)；
(3)????? 过长的函数实现，应将其语句按实现的功能分段加以概括性说明。
c.?????? 常量和变量的注释
在常量名声明后应对该名做适当的注释，注释说明的要点是：
(1)????? 被保存值的含义(必须) ；???
(2)????? 合法取值的范围(可选)；
(3)????? 全局量需要对以上逐点做充分的说明。
d.?????? 制定对象的注释
每个开发人员针对自己所制定的窗口、菜单、数据窗口、数据管道和用户对象等添加注释，要点是：
(1)????? 标注对象的用途；
(2)????? 标注对象的制定人员；
(3)????? 标注时间或者修改时间。
具体格式要求如下：
1. 在窗口Open事件前应说明 /* ======================================================= */
// 窗口中英文名称：
// 窗口作用：
// 作者：
// 日期：
/* ======================================================= */
2. 在事件脚本(Script)之前应说明 /* ======================================================= */
// 脚本作用：
// 输入参数及数据类型：
// 返回参数及数据类型：
// 全局函数及其用途：
// 全局变量及其用途：
// 作者：
// 日期：
// 修改人的姓名：
// 修改日期：
// 修改原因：
/* ===================================================== */
若有多人修改，每个人均加上自己的注释，而不能改他人的姓名、日期、原因，对要修改的脚本，只能注释不能删除，并且在修改的地方加上修改人名、日期和Beginning Modification... ，Ending Modification字样。
3. 脚本中的注释 ?? 单行脚本程序注释：
?????? // 注释文本???????
?? 脚本的程序段注释：
??????? /* ================================== */
//
??????? //?? 注释文本
//
??????? /* ================================== */
?? 变量的注释如下：
?????? 数据类型?? 变量名?? //注释
4. 在函数、存储过程等脚本(Script)之前应说明 /* ======================================================= */
// 函数名称：
// 参数解释：
// 功能描述：
// 调用举例：
// 最初作者：
// 编写日期：
// 返 回 值：
// 变量情况：
// 修 改 人：
// 修改日期：
// 修改原因：
/* ========================================================
显示全部