PB程式規範

作者：達通興電腦科技公司(www.study01job.com) 郭寶利

一、 書寫格式

a.用分層縮排的寫法顯示嵌套結構的層次。

b.在注釋段與程式段，以及不同邏輯的程式段之間插入空行。

c.每行唯寫一條語句，當需要滾動顯示時應該分行書寫。

二、 流量控制

流量控制首先應遵守PowerBuilder文法規範，且用分層縮排的寫法反白嵌套的階層，例如：

三、注釋及格式要求

注釋總是加在程式中需要概括性說明或不易令人理解或容易令人理解錯的地方。注釋語言應簡練、易懂而又準確，所採用的語種首選是中文，如有輸入困難或特殊需求也可採用英文。

注釋原則：

a.函數或過程的注釋

(1).在函數頭部必須說明函數的功能和參數（值參、變參）；

(2).在函數的主體部分，如演算法複雜時，應以注釋的方式對其演算法結構做出說明；

(3).函數申請過全域資源且有可能導致資 源緊張應加以註明(如記憶體和檔案柄等)；

(4).函數有副作用一定以十分醒目的方式(如加!號等)註明。

b.語句的注釋

(1).應對不易理解的分支條件運算式加註釋；

(2).不易理解的迴圈，應說明出口條件(有GOTO的程式還應說明允入準則)；

(3).過長的函數實現，應將其語句按實現的功能分段加以概括性說明。

c.常量和變數的注釋

在常量名聲明後應對該名做適當的注釋，注釋說明的要點是：

(1).被儲存值的含義(必須)  ；    

(2).合法取值的範圍(可選)；

(3).全域量需要對以上逐點做充分的說明。

d.制定對象的注釋

每個開發人員針對自己所制定的視窗、菜單、資料視窗、資料管道和使用者物件等添加註釋，要點是：

(1).標註對象的用途；

(2).標註對象的制定人員；

(3).標註時間或者修改時間。

具體格式要求如下：

1. 在視窗Open事件前應說明

/* ======================================================= */

// 視窗中英文名稱：

// 視窗作用：

// 作者：

// 日期：

/* ======================================================= */