ORACLE编程规范(5)

规则：除非必要，不允许使用数字或较奇怪的字符来定义标识符。 示例：

如下命名，使人产生疑惑。

DECLARE temp_0_TEST VARCHAR2(10);

规则：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 示例：

Start <-> Finish First <-> Last Prior <-> Next Add <-> Remove Get <-> Set

启动 <-> 完成 第一个 <-> 最后一个 前一个 <-> 后一个 增加 <-> 删除 创建 <-> 析构 获取 <-> 设置 增量 <-> 减量 加锁 <-> 解锁 打开 <-> 关闭

Create <-> Destroy

Increment <-> Decrement Lock <-> UnLock Open <-> Close

2013-03-28 第21页，共71页

第5章 注释规范

建议：存储过程/函数脚本代码有效注释量应该在20％以上。

说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。

规则：在数据库脚本文件头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数或过程功能简要说明。 示例：

------------------------------------------------------------------------- -- File Name -- Author -- Version -- Date -- Copyright -- Usage -- Comments -- History -- 1. Date -- Author -- 2. ......

-------------------------------------------------------------------------

: 该脚本文件的文件名 : 该脚本文件的作者姓名与工号 : 该脚本文件的版本号 : 该脚本文件的最后更新日期 : 该脚本文件的版权信息

: 简要描述该脚本的使用/加载方法 : 该脚本文件的注释信息 : 该脚本文件的维护历史信息

: 修改日期，格式为YYYY-MM-DD : 修改人姓名与工号

-- Description : 该脚本文件的描述信息

-- Function List : 该脚本文件提供对象、函数、过程的列表

-- Modification : 修改说明

说明：格式内容请参见代码模板文件头。

规则：函数/存储过程头部应进行注释，列出：功能说明、设计人、编码人、创建日期、修改记录、调用关系（可选）等，输入参数/输出参数/返回值的说明直接添加到参数后面。 示例：

CREATE OR REPLACE FUNCTION F_CSP_FUNCTIONNAME /*

Description : 该函数的功能说明 Author 2013-03-28

: 姓名 工号

第22页，共71页

Date Version Caller Callee Comments History 1. Date */ (

i_DateParam o_IntParam ) RETURN INT AS

DATE,

-- 输入参数注释。包括含义、值域等。 -- 输出参数描述。 -- 返回值。

Author

: YYYY-MM-DD : 版本 : 调用者 : 被调用者

: 注释信息（包括产生异常的说明） :

: 修改日期，格式为YYYY-MM-DD : 修改人姓名与工号

Modification : 修改说明

2. ......

IN OUT VARCHAR2, -- 输入输出参数注释。

o_FloatParam OUT INT

规则：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

规则：注释的内容要清楚、明了，含义准确，防止注释二义性。 说明：错误的注释不但无益反而有害。

规则：避免在注释中使用缩写，特别是非常用缩写。 说明：在使用缩写时或之前，应对缩写进行必要的说明。

规则：单行注释符“--”后必须加上一个空格。

规则：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 示例：

BEGIN ??

-- i_DateParam必须早于当前时间 2013-03-28

第23页，共71页

IF i_DateParam >= SYSDATE THEN RETURN 1; END IF; ?? END;

规则：注释与所描述内容进行同样的缩进。

说明：可使程序排版整齐，并方便注释的阅读与理解。

规则：注释与其上的代码用空行隔开。

建议：对变量的定义和分支语句（条件分支、循环语句等）建议给出注释。

说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。

规则：不允许在一行代码或表达式的中间插入注释。

说明：不应在代码或表达中间插入注释，否则容易使代码可理解性变差。

规则：通过对函数或过程、变量、结构等合适的命名以及合理地组织代码的结构，使代码成为自注释的。

说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。

规则：在代码的功能、意图层次上进行注释，提供有用、额外的信息。

说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 示例：

如下注释意义不大

-- i_RetCode = 0 IF i_RetCode = 0 THEN

2013-03-28 第24页，共71页

而如下的注释则给出了额外有用的信息。

-- 流程传入的标志为发送成功 IF i_RetCode = 0 THEN

2013-03-28

第25页，共71页

百度搜索“77cn”或“免费范文网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读，免费范文网，提供经典小说综合文库ORACLE编程规范(5)在线全文阅读。