26、PLSQL格式化指南

命名规范 3-1
• 为防止命名与保留字和列/表名冲突，有必要 使用如下前缀:
– v_variable_name （变量名） – con_constant_name （常量名） – i_in_parameter_name，o_out_parameter_name， io_in_out_parameter_name （过程和函数的参数名） – c_cursor_name或者name_cur （游标名） – rc_reference_cursor_name （引用游标名） – r_record_name或者name_rec （记录名） – FOR r_stud IN c_stud LOOP... （游标FOR循环） – FOR stud_rec IN stud_cur LOOP ...
命名规范 3-2
– type_name , name_type(适用于用户定义类型) – t_table, name_tab(适用于PL/SQL表) – rec_record_name, name_rec(适用于记录变量) – e_exception_name(适用于用户定义异常)
– 包的名称应该是该包中过程和函数所执行动作 较大的上下文的名称
其它建议
• 对于嵌套在PL/SQL中的SQL语句，应该使用 和PL/SQL相同的格式化指南
• 提供注释头来解释语句块的目的，并列出 语句块的创建日期和创建者。同样，还要 说明每次修改，包括修改者的名字、日期 以及对修改内容的描述
代码范例 3-1
代码范例 3-2
代码范例 3-3
注释
• 在PL/ SQL和SQL中，注释都是非常重要的。 使用注释来描述程序段的主要部分以及关 键的重要逻辑步骤 • 最好使用单行注释(--)，避免使用多行注释 (/*)。尽管PL/ SQL支持这两种注释，但是使 用单行注释有利于代码调试，因为你无法 在多行注释中嵌入多行注释。也就是说， 可以注释掉包含单行注释的代码段，但是 不能注释掉包含多行注释的代码段
– 过程的名称应该能够描述该过程所执行的动作。 函数的名称能够描述返回的数据类型和变量 – 示例：
命名规范 3-3
– PACKAGE student_admin – -- admin后缀表明包中主要是管理操作 – PROCEDURE remove_student (i_student_id IN student.studid%TYPE); – FUNCTION student_enroll_count (i_student_id student.studid%TYPE) RETURN INTEGER;
PL/SQL格式化指南
目标
• 掌握PL/SQL编程规范
PL/SQL格式化指南
• • • • • 大小写 空白 命名规范 注释 其它建议
大小写
• PL/SQL语言和SQL一样，都是大小写不敏感 的。常见指南如下:
– 保留字 (BEGIN， EXCEPTION, END , IF THEN ELSE, LOOP, END LOOP等)、数据类型(VARCHAR2， NUMBER等)、内置函数(LEAST， SUBSTR等) 以 及用户定义的子过程名称(过程、函数、包)都 要使用大写字母 – 变量名以及在SQL中所使用的列和表名，都应 该使用小写字母
空白
• 在PL/SQL中，空白是非常重要的，它是提升代码可 读性的重要手段。也就是说，可以在代码中使用缩 进来展示程序的逻辑结构。下面是一些建议:
– 在等号符号或者比较操作符的两边使用空格 – 把结构相关的保留字左对齐 (DECLARE、BEGIN、 EXCEPTION和END，IF和END IF 以及LOOP和END LOOP)。 除此之外，进行结构性缩进时一般每次使用3个空格(使 用空格键，而不是Tab键) – 在主要代码段之间使用空白行，ห้องสมุดไป่ตู้便于隔离不同功能 的代码 – 把相同结构的不同逻辑部分放在不同的代码行中，即 使语法结构很简单也应该如此。例如IF和THEN放在一行 上，而ELSE和ENDIF会放在单独行上