PLSQL码规范.docVIP

PL/SQL编码规范PL/SQL编码规范PL/SQL对大小写不敏感，故切忌使用大小写区分变量和其它用户定义的元素。为使代码具有可读性，可遵循以下简单的大小写规则以便在源代码中区分这些元素：全部保留字、Oracle提供的程序包、内建函数、用户定义的常数、Oracle和用户定义的数据类型，以及模式名均采用大写；所有程序命名和过程名称全部采用大写。修改前必须从CVS去取最新的版本去，同时如存在多个人同时修改的情况，请注意协调分工，注意事后合并版本。所有的包和过程等PL/SQL脚本，请将最新的放在CVS上，文件夹结构要与PL/SQL的对象结构一致，如（Functions、Packages、Procedures等）。PL/SQL的包和包体将采用一个文件，名称为包的名字，保留到CVS时请不要将包和包体分开为两个文件update到CVS。在提交到CVS上去以前，请清理掉临时的变量，和编码的时候采用的临时表等。代码编译通过后保证没有警告提示。程序命名规范无论是PL/SQL对象还是PL/SQL对象内部用的变量和游标等，都必须能从名称上能让人理解变量和游标的含义，而且一定要做好注释。传到CVS上的文本文件全部采用’.sql’作为文件名的后缀程序包程序包的命名必须符合PCKG_DETAILNAME格式，其中 PCKG表示是程序包， DETAILNAME是与程序包意义相关的意义的名称，例如：PCKG_SORCE_ALL。范例：/*********************************************\* Name(名称): PCKG_EXAMPLE* Purpose(功能说明): 包的编码规范示例，如何编写包， 包中如何写存储过程及函数* Author(作者): XXX* Create At(创建时间): XXXX-XX-XX\*********************************************/CREATE OR REPLACE PACKAGE PCKG_EXAMPLE IS /***类型或全局变量定义区***/  TYPE TYP_CURSOR IS REF CURSOR;  /***函数或存储过程定义区***/ /*********************************************\ * Name(名称): PROC_GET_USER_BY_NAME * Purpose(功能说明): 根据姓名查询用户资料 * Author(作者): XXX * Create At(创建时间): 2007-10-29 \*********************************************/ PROCEDURE PROC_GET_USER_BY_NAME( i_user_name IN VARCHAR2,--用户姓名 o_retcode OUT VARCHAR2,--返回标志0成功、1失败... o_errmsg OUT VARCHAR2,--返回失败信息 o_user_cur OUT TYP_CURSOR--返回用户列表 );END PCKG_EXAMPLE; 存储过程存储过程的命名必须符合PROC_DETAILNAME格式，其中 PROC表示是存储过程，DETAILNAME是与存储过程意义相关的意义的名称，如：PROC_BUSINESS_RULE。若是执行用户的请求，至少要定义两个出参作为响应参数，第一个参数(o_retcode)告知用户执行结果成功(0)或失败(1)，第二个参数(o_errmsg)告知用户具体的错误信息，其它出参紧随其后。范例：/*********************************************\ * Name(名称): PROC_GET_USER_BY_NAME * Purpose(功能说明): 根据姓名查询用户资料 * Author(作者): XXX * Create At(创建时间): XXXX-XX-XX \*********************************************/CREATE OR REPLACE PROCEDURE PROC_