PLSQL开发规范.doc

PL/SQL的编程规约 目的 本规约仅作为开发人员进行PL/SQL开发时的指导方针。 命名规则 变量、参数的命名规则 a． 变量、参数命名一般用英文的名词、名词组合或名词缩写的组合来表示，单词的第一个字母用大写，其余用小写字母表示。 b． 表示的单词一般使用大家所熟知，并能表达意义的英文。 c． 不能用汉字表示。 d． 参数的命名以“P_”开头。 例 P_Return NUMBER; e． 变量的命名以“WK_”开头。 例 WK_Count NUMBER; f． 对于全局和局部变量要有明显的区分。全局变量以“GWK_”开头，其它规则同变量的命名规则。 例 GWK_Count NUMBER; Cursor的命名规则 Cursor的命名以“Csr”开头，其它规则同变量的命名规则。 例 CURSOR CsrAssis 包（Package）的命名规则 a． 包的命名与调用的类名相同。 b． 过程以“Prc”+机能描述来命名。当输出结果有零个或多于一个时采用过程实现。 c． 函数以“Fnc”+机能描述来命名。当输出结果只有一个时，原则上采用函数实现。 触发器的命名规则 a． 触发器以“Trg”+机能描述（如增加表YM，用“YMIns”代替）来命名，如INSERT用Ins；SELECT用Sel；UPDATE用Upd；DELETE用Del分别代替。 包（Package）的分割基准 a． 包的分割以调用的每个类单位作为分割基准。 b． 当过程被多个类调用时，做成公共的过程，否则做成包内的过程。 c． 当函数被多个类调用时，做成公共的函数，否则做成包内的函数。 关键字或保留字 关键字或保留字的第一个字母用大写，其余字母用小写；或者全部用大写； 错误处理 a．各个过程必须用EXCEPTION进行块处理异常错误，并对系统错误的处理做如下规范： ACCESS_INTO_NULL 返回号： 1 COLLECTION_IS_NULL 返回号： 2 CURSOR_ALREADY_OPEN 返回号： 3 DUP_VAL_ON_INDEX 返回号： 4 INVALID_CURSOR 返回号： 5 INVALID_NUMBER 返回号： 6 LOGIN_DENIED 返回号： 7 NO_DATA_FOUND 返回号： 8 NOT_LOGGED_ON 返回号： 9 PROGRAM_ERROR 返回号：10 ROWTYPE_MISMATCH 返回号：11 STORAGE_ERROR 返回号：12 SUBSCRIPT_BEYONG_COUNT 返回号：13 SUBSCRIPT_OUTSIDE_LIMIT 返回号：14 TIMEOUT_ON_RESOURCE 返回号：15 TOO_MANY_ROWS 返回号：16 VALUE_ERROR 返回号：17 ZERO_DIVIDE 返回号：18 b．用户自定义的异常情况 返回号：90 ~ 98 c．Cursor Empty 返回号： 99 d．其它 返回号： SQLCODE 5、 注释 1） 在包头的开始位置做如下内容的注释： a． 系统名 ： 系统的名称 （例：XXX管理系统） b． 程序名 ： 程序名称 （例：BKJ1001） c． 程序概要 ： 程序功能的概要叙述（例：XXXX处理） d． 作 成 ： 作者和日期 （例：2001/08/15 姓名）