数据库开发规范.docx

ACC数据库开发规范
编程规范
1:所有数据库关键字和保留字都大写;字段、变量的大小写
2:程序块采用缩进风格书写,保证代码清晰易读,风格一致,缩进格数统一为2/4个。
必须使用空格,不允许使用【tab】键。
3:当同一条语句暂用多于一行时,每行的其他关键字与第一行的关键字进行右对齐。
4:不允许多个语句写到一行,即一行只写一条语句。
5:避免把复杂的SQL语句写到同一行,建议要在关键字和谓词处换行。
6:相对独立的程序块之间必须加空行。BEGIN、END独立成行。
7:太长的表达式应在低优先级操作符处换行,操作符或关键字应放在新行之首。不同类型的操作符混合使用时,用括号隔离,使得代码清晰。
8: 不同类型的操作符混合使用时,应使用括号明确的表达运算的先后关系。
9:运算符以及比较符左边或者右边只要不是链接的括弧,则空一格。
10:if 后的条件要用括号括起来,括号内每行最多两个条件。
11:减少控制语句的检查次数,如在 else( if..else)控制语句中,对最常用符合条件,尽量往前被检查到。尽量避免使用嵌套的if 语句,在这种情况应使用多个if 语句来判断其可能。
命名规范
1:不使用数据库关键字和保留字,为了避免不必要的冲突和麻烦。
2:严禁使用带空格的名称来给字段和表命名,会出错误而终止。
3:用户自定义数据库对象:表,视图,主外键,索引,触发器,函数,存储过程,序列,同义词,数据库连接,包,包体风格要保持一致。
数据库名称1-8个字符,其他对象1-30个字符,数据库连接不操过30个字符。使用英文字母、数字、下划线。
除表外,其他对象命名最好用不同的前缀来区别。
表 t_
视图 v_
序列 seq_
簇 c_
触发器 trg_
存储过程 sp_/p_
函数 f_/fn_
物化视图 mv_
包和包体 pkg_
类和类体 typ_
主键 pk_
外键 fk_
唯一索引 uk_
普通索引 idx_
位图索引 bk_
4:PL/SQL对象和变量命名规则
输入变量 i_
输出变量 o_
输入输出变量 io_
普通变量 v_
全局变量 gv_
常量大写
游标 cur_
用户自定义类型 type_
保存点 spt_
不允许使用中文和特殊字符
用户对象命名应全部为小写,且不允许使用控制符号强制转换对象为小写字符
变量命名,要有具体含义,能表明变量类型。
5:注释规范
源程序有效注释量必须在30%左右。
统一文件头的注释,针对存储过程,函数进行功能性描述,入出参数说明。
/*******************************************************************
名称:
功能描述:
修订记录
版本号编辑时间编辑人修改描述
入出参数说明
返回值描述(针对函数)
*******************************************************************/
所有变量定义需要添加注释,说明该变量的用途和含义。
程序分支必须书写注释,这些语句是程序实现某一特定功能的关键。
在程序块的结束行加注释,表明程序块结束。
注释应与描述