PLSQL编码规范总则.docx

PLSQL编码规范总则.docx

《PLSQL编码规范总则.docx》由会员分享，可在线阅读，更多相关《PLSQL编码规范总则.docx（9页珍藏版）》请在冰豆网上搜索。

PLSQL编码规范总则

PLSQL编码规范-总则

文件编号：

版本：

1.2

拟制　

审核

会签

标准化

批准

XXXXX公司

XXX部

目录

前　言4

1范　围5

2术语和定义5

3总　则5

3.1文件风格规范5

3.1.1程序头7

3.1.2程序体8

3.2描述和注释规范8

3.3代码规范10

版本变更记录

版本号

拟制/修改日期

拟制/修改人

修改记录

批准人

1.0

2004-7-27

徐奇

创建

1.1

2004-8-12

虞渊明

修改文件名称

1.2

2005-3-16

韩荣华

根据过程资产库架构指南调整文件名及引用

陈沛

注：

1）拟制、审核、会签、批准不走电子流程时，必须用钢笔或签字笔填写，不得用铅笔、圆珠笔填写，不得涂改。

<本规范中用“<>”括起来的内容是编写指导，在最终的文档中应予以删除。

其它内容应予以保留。

如果某节内容无需填写，则在该节下写“无”，而不要将本节删除或不填写任何内容（留白将无法判断：

是本节内容无需填写还是因为疏忽而忘了填写。

）>

前　言

编码规范包括总则和细则两部分。

总则部分是对编码的总体性规范要求，适用于多种编码语言；细则部分是在总则的规范要求下，针对具体语言的特点而提出的规范要求。

本规范是编码规范的总则部分。

编写本规范的目的是为了统一软件编程风格，提高软件源程序的可读性、可靠性和可重用性，确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作，提高软件源程序的质量和可维护性，减少软件维护成本。

本规范内容上包括文件风格规范、描述和注释规范、代码规范三部分。

自本规范实施之日起，以后新编写的和修改的代码均应执行本规范。

1范　围

本规范规定了PLSQL代码文件的编码规范总则，适用于PLSQL软件编码。

本规范自生效之日起，对以后新编写的和修改的代码有约束力。

2术语和定义

软件文档：

软件文档包括外部文档和内部文档。

外部文档（如规范、帮助文件和设计文档）在源代码的外部维护。

内部文档由编码人员在编码时在源代码中编写的描述和注释组成。

3总　则

3.1文件风格规范

代码文件由两部分组成：

程序头和程序体。

程序头包括文件描述区和修改记录区；程序体由区段组成，区段又由代码段组成，代码段包括描述区、代码区和注释区。

3.1.1程序头

1．文件描述区：

（1）格式要求：

（2）内容说明：

1）所属系统名称为正式立项的系统名称；

2）关键词指主要的函数和过程；

3）主要功能包括前置条件、后置条件、处理过程等。

2．修改记录区：

（1）格式要求：

（2）内容说明：

更改内容中要列出所有维护和升级内容。

3.1.2程序体

1．区段：

（1）格式要求：

（2）内容说明：

区段要有明显的开始和结束标记；

2．代码段：

（1）格式要求：

（2）内容说明：

1）描述区的主要功能不但要说明做什么，还要说明原因，以及如何改变对象。

2）注释区不但要说明代码做了些什么，还要说明这样做的原因。

3）注释区的格式标准与编程语言有关，具体要求参见编码规范细则。

4）代码区的书写与编程语言有关，具体要求参见编码规范细则。

3.2描述和注释规范

1．一般情况下，源程序有效描述和注释量必须在30％以上。

说明：

描述和注释有助于理解代码，有效的描述和注释是指在代码的功能、意图层次上进行说明，提供有用、额外的信息，而不是代码表面意义的简单重复。

2．代码文件中一行的描述和注释不能超过80列。

说明：

为了防止在阅读代码时不得不滚动源代码编辑器。

包括空格和代码。

3．描述和注释使用中文。

说明：

对于特殊要求的可以使用英文注释，如工具不支持中文或国际化版本时。

4．保证代码和描述、注释的一致性。

说明：

修改代码同时修改相应的描术和注释，不再有用的注释要删除。

5．描述和注释要避免使用装饰性内容。

说明：

如用星号将内部注释圈起来。

因为不同的编辑器对有些字体的显示和打印是不成比例的，所以无法将那些框排整齐。

6．要保持描述和注释的简洁。

说明：

最好的注释应该是简单明了的注释。

注释不必洋洋洒洒，只需提供足够的信息，使别人能够理解你的代码。

7．先写注释，后写代码，或者边写代码边写注释。

说明：

在软件开发过程中及早注释代码，会促使在开始编写代码之前仔细考虑这些代码，从而带来更高的工作效率，而且这样确保不会遗漏注释。

8．注释信息不仅要包括代码的功能，还应给出原因。

说明：

注释信息不但要说明代码做了什么，还要说明为什么这样做。

9．代码注释的方式要遵循编码规范细则要求。

说明：

因为代码注释方式很大程度上可以影响工作效率以及所有维护改进代码的后继开发者的工作效率。

3.3代码规范

1．面向人而不是面向机器编码。

说明：

这是软件开发的基本要点，软件的生命周期贯穿产品的开发、测试、生产、用户使用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力。

使你的代码为别人所理解是最重要的。

2．首先设计，然后编写代码。

说明：

在实际开始动手写代码之前花时间想清楚打算怎样写代码，可以减少编写的时间。

先设计将潜在地减少将来修改代码所带来的影响。

3．编写代码分段进行。

说明：

一小步一小步地开发，比一次性地写完所有代码然后修改它要有效得多。

在一小部分代码中寻找问题会比在一大段代码中找问题要快得多。

通过一小步一小步逐步地开发，减少了查找错误所需的平均时间，从而又减少整个开发时间。

4．保持代码的简明清晰，避免过分的编程技巧。

说明：

要使代码简单直白。

保持代码的简单化是软件工程化的基本要求。

不要过分追求技巧，否则会降低程序的可读性。

5．编程时首先达到正确性，其次考虑效率。

说明：

编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，最后才考虑程序的效率和资源占用。