PLSQL编码开发规范

《PLSQL编码开发规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、PLSQL开发规范Andrew.zhao日期作者版本变更说明2013-6-7Andrew.zhaoV1.0原始版1.PL/SQL编码规范1.1.使用工具Toad或PL/SQLDeveloper1.2.使用基表(视图)别名在SQL语句中为表或视图指定别名。其命名规格以简短为原则，一般为基表或视图名称每一节单词的第一个字母，如mtl_system_items的别名一般指定为msi。1.3.例外处理尽可能多的使用EXCEPTION捕捉各种例外，并返回用户可读懂的信息，如无法确定是否有其它例外，可在每个PL/SQL程序块的例外中加上WHENOTHERS语句。例外信息统一风格

2、，定义统一的例外处理Package统一返回在哪个Package、Procedure中发生的例外对日志中的一些调试信息，通过参数设定是否需要输出语法如下：EXCEPTIONWHENOTHERSTHENFND_FILE.PUT_LINE(FND_FILE.OUTPUT,SQLCODE);FND_FILE.PUT_LINE(FND_FILE.OUTPUT,SQLERRM);END;1.4.注释PL/SQL有两种表示注释的方法，分别为’--’和’/*…*/’,对于多行或整段的注释一般采用后者，对于单行或行尾的注释一般采用前者。以下从几个主要地方注释做个规定，力求统一。注释风

3、格：注释单独成行、放在语句前面。应对不易理解的分支条件表达式加注释；对重要的计算应说明其功能；过长的函数实现，应将其语句按实现的功能分段加以概括性说明；常量及变量注释时，应注释被保存值的含义(必须)，合法取值的范围；可采用单行/多行注释。（--或/**/方式）。l包、过程、函数注释(代码头信息注释规范)/*===============================================================*Copyright(C)CNCAllrightsreserved*===================================

4、============================*ProgramName:[PackageName]*Author:$OSUSER*Date:$DATE$TIME*Purpose:[Purpose]*Parameters:*InX--参数X的简要说明*OutY--参数Y的简要说明*Called:*CalledBy:*Description:**UpdateHistory*VersionDateNameDescription*-----------------------------------------------------*V1.0$DATE$OSUS

5、ERCreation*===============================================================*/如增加包中的过程或函数，需在包的注释中的UpdateHistory中增加相应的信息。如仅是修改过程或函数，则在过程或函数的注释中的UpdateHistory中增加相应的信息。l注释的基本原则过程中定义的变量需要注释其含义，过程或函数中关键性语句也要注释其作用，对于较复杂的程序，则对该段程序的流程进行描述，在程序中的关键位置应加入相应的注释，对于非首次作者修改原有的程序，要对所做的修改部分加以标示，并作相应的注释。注释

6、的格式无特殊要求，一般单行以’--’注释，多行以/*…*/注释。l增加程序selectcount(*)fromwhereand--addedbyxxx2006-05-28and--endaddedbyxxx2006-05-28and蓝色部分为新增加的程序l修改/删除程序selectcount(*)fromwhereand--changedby

7、xxx2006-05-28--andand--endchangedbyxxx2006-05-28and蓝色部分为修改的程序，修改为1.1.代码语法规范语法规范主要包括变量规范、包规范、游标规范、事务处理规范等等1.1.1.变量规范1)变量名全部采用小写，局部变量名使用“v_”开头，输入参数以“i_开头，输出参数以“o_”开头，输入输出参数用io_开头。所有输入参数必须显示声明。2)游标的命名，游标统一用“c_”命名