ORACLE数据库编程开发规范.doc

ORACLE数据库编程规范
目录
第1章 范围和简介 4
简介 4
范围 4
关键词 4
术语和定义 4
第2章 文件格式及命名 5
文件格式 5
文件命名 5
第3章 书写规范 6
大小写风格 6
缩进风格 7
空格及换行 11
创建表 14
创建过程/函数/包 14
第4章 命名规范 16
第5章 注释规范 21
第6章 常用语法 25
变量声明 25
返回值 25
符号* 25
包的使用 26
绑定变量 26
异常处理 28
事务控制 29
游标使用 29
代码规模 31
第7章 SQL建议与约束 32
建议 32
禁止 35
第8章 开发工具 40
UltraEdit-32 40
PL/SQL Developer 40
TOAD 40
PowerDesigner 41
第9章 数据库代码走读CheckList 42
第10章 附录 45
常见模块缩写表 45
常用词缩写表 46
表目录
表1 大小写规范表 7
表2 对象前缀表 17
表3 ORACLE系统对象使用前缀表 18
表4 参数、变量、常量、异常等前缀表 19
表5 常见模块缩写表 46
表6 常用词缩写表 47
范围和简介
简介
本规范是针对关系型数据库ORACLE的相关特性,拟定的用于指导和规范相关开发过程的规范,其旨在通过该规范的约束和建议,使开发人员可以在他们所编写的代码中保持统一正确的风格,提供代码的可读性以及减少出现错误的几率。
范围
本规范仅适用于关系型数据库系统ORACLE以及其对应的PL/SQL脚本语言。
关键词
编程规范、数据库、ORACLE、PL/SQL
术语和定义
本规范采用以下的术语描述:
★规则:编程时强制必须遵守的原则。
★建议:编程时必须加以考虑的原则。
★说明:对此规则或建议进行必要的解释。
★示例:对此规则或建议从正、反两个方面给出。
文件格式
文件格式
规则:数据库脚本文件的文件格式必须为纯文本,不允许使用包含格式文本的文件格式。
书写规范
大小写风格
规则:数据库脚本中涉及到的各种保留字、关键字、操作符、数据类型、标识符、对象、字段、变量、常量等的大小写风格必须遵循以下规范:
大小写规范表
文字类型
大小写
示例
ORACLE保留字(Reserved Word)
大写
IDENTIFIED、INITIAL、LONG、MAXEXTENTS、RENAME、ROWNUM、SYSDATE、VARCHAR2
ORACLE关键字(Keywords)
大写
ANALYZE、PILE、DBA、EXTENT、INSTANCE、MAXTRANS、SAVEPOINT、TABLESPACE
ANSI SQL保留字(Reserved Word)
大写
ADD、BETWEEN、CREATE、DISTINCT、DROP、FROM、SESSION、SELECT、TABLE、UPDATE、VARCHAR
ANSI SQL关键字(Keywords)
大写
MIT、CONSTRAINT、COUNT、CURSOR、DECLARE、EXECUTE、PRIMARY、SUM、TRANSACTION
PL/SQL保留字(Reserved Word)
大写
ARRAY、BOOLEAN、DATABASE、DO、EXIT、RAISE、SAVEPOINT、RUN、WHILE、XOR
操作符(Operators)
大写
ALL、AND、ANY、ESCAPE、EXISTS、OR、UNION
数据类型(Data Types)
大写
INT、NUMBER、DATE
系统数据库对象(System Tables、Views、Functions、Packages、Package Methods、Exceptions)
大写
USER$、DBA_JOBS、DECODE、SUBSTR、DBMS_OUTPUT、PUT_LINE、NO_DATA_FOUND
自定义数据库对象(User Objects)
大写
T_PUB_TABLE_NAME、F_PUB_GETID、P_KBS_GET_SERVICEINFO
字段名(Field)
大写
USER_NAME、STAFFNO
常量(Constants)
大写
SECONDS_OF_DAY
变量(Variable)
逻辑首字母