关于程序规范.doc

程序书写规范
变量的规范
变量的定义:
定义变量时,采用“变量类型+变量名称”的方式,变量的第一个字母表示类型要小写,如int iCount=0; 无论程序中什么位置看见这个变量,就让看程序人,很清楚,这是一个整型的变量;同理char,long, double,struct 都按照这个规则来定义变量。
如: struct mdm_ac_rel_c sMdm_ac_rel;
变量的第二个字母要大写,两个不用的英文单词要共同使用时要以大小写区分或以下划线区分,如long lLst_date=0,又如long lLstDate=0;
定义变量最好清晰、明了,有明确的含义,最好不好太长,同时要给该变量增加相应的注释。
命名中若使用特殊约定或缩写,则要有注释说明,同时要注意变量定义都在函数开始部分,尽量别在程序中间别定义。
变量的初始化:
变量的初始化,是一个看似简单问题,却又是一个不易被测出、比较隐蔽,造成程序执行错误的重要原因;特别是在批量交易中,对已经多次发现的批量问题,分析后绝大部分是由于变量初始化的原因造成的。
程序变量定义后一定要初始化,如果一个程序多处用到了同一个表的不同操作,尽量定义成不同的表名,结构体分别使用;特别是循环中反复要用到的变量或者定义的DBS结构体,要注意变量的有效范围和初始化,不要在有效范围外还存有该变量的值。
变量的使用范围:
注意全局变量、静态变量、局部变量的区别。
变量类型的定义详见下表:
Datatype
begin
bits
range
example
boolean
b
1
0~1
bBadRead
char
c
8
-128-127
cTx_code
int
i
16
-32768~32767
iCount
long
l
32
-2147483648~2147483647
lLst_date
double
d
8
+/-308 (15 digits)
dMount
long double
ld
10
+/-4932 (19 digits)
ldTxAmt
void
v
N/A
N/A
vTmp
struct
s
N/A
N/A
sIn_mst
pointer
p
N/A
N/A
pCode
变量的长度:
有共同特征的一类变量,如柜员的长度、交易机构的长度、账户的长度等等,每个地方这些信息的长度都是固定的,所以咱们可以使用宏定义的长度,到每个地方都只是改动宏定义即可。
注意不同类型变量的有效范围,如int ,long,double等等。
在变量的拷贝过程中,要注意前后两个变量的类型以及各自的长度,是否会造成错误。
注意事项:程序中不用的变量尽量去掉,规范的企业中绝不允许有变量定义不使用的情况。
程序的格式规范:
常量的命名最好用大写,单词之间用“_”连结。
全局变量在单词最前面加“_”,如:_cQs_br_no。
相对独立的程序块之间、变量说明之后必须加空行。
动态内存分配的释放。如果程序中存在申请了动态内存,注意函数返回时要释放内存。(特别是异常退出也应做相应的释放)