PLSQL编码规范.doc免费

文档状态： 文档编号： 规范_PL/SQL编码 [ ] Draft [√] Released [ ] Modifing 编 撰： 编撰日期： 2006-5-21 必威体育官网网址级别： 机密 文档版本： 2.0.0 PL/SQL编码规范 XXX信息技术公司 版 本 历 史 日期 版本 说明 作者 2006-04-08 0.0.1 初稿 2006-04-30 1.0.0 咨询公司审计通过，正式发布 2006-05-21 2.0.0 增加系统集成项目过程 目 录 1 目的 4 2 范围 4 3 规范内容 4 3.1概述PL/SQL语言的特点 4 3.2 整体风格 4 3.3 过程和函数编写风格 5 3.4 包的编写风格 6 3.5 触发器的编写风格 7 3.6 标识符命名规范 8 3.7 注释要求 10 3.8 标识符声明 11  PL/SQL编码规范 目的 为了保证所每个项目组编写出的程序都符合相同的规范保证一致性、统一性而… end loop; end; 空格 原则上变量、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。 对齐 原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在,处或运算符处。 例如： … Type t_StudentRecord is Record( FirstName Varchar2(10), LastName Varchar2(10), CurrentCredits Number(3) ); v_Student t_StudentRecord; … 空行 不应该存在无规则的空行，比如说连续十个空行。程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行，由于每个函数还要有函数说明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。 注释 注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%，软件工程要求不少于20%。 代码长度 对于每一个函数建议尽可能控制其代码合理的长度（50行左右），超过50行的代码要重新考虑将其拆分为两个或两个以上的函数。超长的语句应该在一个逗号或者一个操作符后折行。 3.3 过程和函数编写风格 PL/SQL中的函数和过程（通常称为子程序）是PL/SQL块的一种特殊类型，这种类型的子程序可以以编译的形式存放在数据库中，并为后续的程序块调用。 函数和过程的命名 通常，函数和过程的命名是以能表达函数和过程的动作意义为原则。可以是由动词打头，然后跟上表示动作对象的名词，各单词的首字母应该大写。另外，还有一些函数命名的通用规则，如取数，则用Get打头，然后跟上要取的对象的名字；设置数，则用Set打头，然后跟上要设的对象的名字；而对象中为了响应消息进行动作的函数，可以命名为On打头，然后是相应的消息的名称；进行主动动作的函数，可以命名为Do打头，然后是相应的动作名称。 函数格式 例如： Create and Replace Function Balance (acct_id INTEGER) RETURN REAL IS acct_bal REAL; BEGIN SELECT bal INTO acct_bal FROM accts WHERE acct_no = acct_id; RETURN acct_bal; END Balance; 过程格式 例如： Create or Replace PROCEDURE Raise_salary (emp_id INTEGER, amount REAL) IS current_salary REAL; salary_missing EXCEPTION; BEGIN SELECT sal INTO current_salary FROM emp WHERE empno = emp_id; IF current_salary IS NULL THEN RAISE salary_missing; ELSE UPDATE emp SET sal = sal + amount WHERE empno = emp_id; END IF; EXCEPTION WHEN NO_DATA_FOUND THEN INSERT INTO emp_audit VALUES (emp_id, No such number); WHEN salary_missing THEN