PLSQL编码规总则分析和总结.docxVIP

第 第 PAGE 1 页 共 10 页 技 术 文 件 技术文件名称：PLSQL 编码规-总则技术文件编号： 版 本：1.2 共 10 页 (包括封面) 拟 制 徐奇 审 核 会 签 标准化批 准 中兴通讯股份有限公司质企中心 IT 部 PLSQL 编码规-总则 PLSQL 编码规-总则 第 第 PAGE 10 页 共 10 页 目 录 前 言 4 范 围 5 术语和定义 5 总 则 5 文件风格规范 5 程序头 7 程序体 7 描述和注释规范 8 代码规范 9 版本变更记录 版本号 拟制/修改 日期 拟制/修改人 修改记录 批准人 1.0 2004-7-27 徐奇 创建 1.1 2004-8-12 虞渊明 修改文件名称 1.2 2005-3-16 韩荣华 根据过程资产库架构指南调整文件名 及引用 陈沛 注： 1）拟制、审核、会签、批准不走电子流程时，必须用钢笔或签字笔填写，不得用铅笔、圆珠笔填写，不得涂改。 本规范中用“ ”括起来的内容是编写指导，在最终的文档中应予以删除。其它内容应予以保留。 如果某节内容无需填写，则在该节下写“无”，而不要将本节删除或不填写任何内容（留白将无法判断：是本节内容无需填写还是因为疏忽而忘了填写。） 前 言 编码规范包括总则和细则两部分。总则部分是对编码的总体性规范要求，适用于多种编码语言；细则部分是在总则的规范要求下，针对具体语言的特点而提出的规范要求。本规范是编码规范的总则部分。 编写本规范的目的是为了统一软件编程风格，提高软件源程序的可读性、可靠性和可重用性，确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作，提高软件源程序的质量和可维护性，减少软件维护成本。 本规范内容上包括文件风格规范、描述和注释规范、代码规范三部分。自本规范实施之日起，以后新编写的和修改的代码均应执行本规范。 范 围 本规范规定了PLSQL 代码文件的编码规范总则，适用于PLSQL 软件编码。本规范自生效之日起，对以后新编写的和修改的代码有约束力。 术语和定义 软件文档：软件文档包括外部文档和内部文档。外部文档（如规范、帮助文件和设计文 档）在源代码的外部维护。内部文档由编码人员在编码时在源代码中编写的描述和注释组成。 总 则 文件风格规范 代码文件由两部分组成：程序头和程序体。程序头包括文件描述区和修改记录区；程序体由区段组成，区段又由代码段组成，代码段包括描述区、代码区和注释区。 程序头 程序头 文件描述区 修改记录区 程序体 程序体 区段 1 开始标记 区段代码1 开段始1 描述区 代码段 11代描码述区区 代码段 1 注释区 代码段 1 代码区 代码段 1 注释区 ?? ?? 代码段n 描述区 ?? ?? 代码段 nn代描码述区区 代码段n 注释区 代码段n 代码区 代码段n 注释区 区段 1 结束标记 ?? ?? 区段 n1开结始束标记 代码段 1 描述区 代码段 1 代码区 代码段 1 注释区 ?? ?? 代码段n 描述区 代码段n 代码区 代码段n 注释区 区段 n 结束标记 版权信息：文件编号： 文件名称： 系统编号： 系统名称： 模块编号：模块名称：作 版权信息： 文件编号： 文件名称： 系统编号： 系统名称： 模块编号： 模块名称： 作 者： 完成日期： 设计文档：列出相关设计文档的编号、名称。 内容摘要：说明文件包含的主要功能、系统相关界面、包含的区段、关键词及其一般说明。 (2)内容说明： 所属系统名称为正式立项的系统名称； 关键词指主要的函数和过程； 主要功能包括前置条件、后置条件、处理过程等。 2．修改记录区： (1)格式要求： 更改记录 更改日期 更改人 更改内容 2004-7-28 XXX 列出所有的维护和升级内容 （2）内容说明： 更改内容中要列出所有维护和升级内容。 程序体 区段： 格式要求： 区段开始标记 区段开始标记 区段名称： 区段结束标记 内容说明： 区段要有明显的开始和结束标记； 代码段： (1)格式要求： 描述区 描述区 编号： 名称： 内容摘要：说明主要功能、查询字段、被访问数据库对象、查询条件、 参数说明等。 代码区 被访问数据库对象：ZTE_CON_FORECAST_PROJECT 注释区 合同预测项目 说明循环和逻辑分支、局部变 量、复杂代码、处理顺序等 (2)内容说明： 1) 描述区的主要功能不但要说明做什么，还要说明原因，以及如何改变对象。2）注释区不但要说明代码做了些什么，还要说明这样做的原因。 3）注释区的格式标准与编程语言有关，具体要求参见编码规范细则。 4）代码区的书写与编程语言有关，具体要求参见编码规范细则。 描述和注释规范