"PLSolutions编码规范：命名与编码标准指南"

需积分: 10 41 浏览量更新于2024-04-02 收藏 178KB DOC 举报

Some Naming and Coding Standards.doc is a document containing guidelines for naming and coding standards, particularly for PL/SQL but applicable to all programming languages. Created by the company PL Solutions in April 25, 2000, these standards serve as a template for best practices in software development. It emphasizes the importance of consistency and clarity in naming conventions to ensure code readability and maintainability. The document presents guidelines for naming variables, functions, procedures, and packages, recommending descriptive and meaningful names that reflect the purpose and functionality of the code. It also outlines rules for indentation, spacing, and comments to enhance code readability and understanding. These standards are intended to improve code quality, facilitate collaboration among developers, and streamline the debugging and maintenance process. PL Solutions acknowledges that these standards are a work in progress and advises organizations to review and customize them to suit their specific development processes. While the document provides a valuable framework for establishing naming and coding conventions, it is essential for organizations to adapt these standards to their unique requirements and practices. Overall, Some Naming and Coding Standards.doc serves as a valuable resource for developers seeking guidance on best practices in software development. By promoting consistency, clarity, and efficiency in coding practices, these standards can help improve the quality and reliability of software applications across a wide range of programming languages.

tbl Table gtbl_employee

rec Record ltrec_address

One more thing to define. There are two special constructs that are available in PL/SQL. They are

Type and Subtype. We are going to treat these as datatypes.

Type Description Example

typ TYPE gtyp_new_account_table

stp SUBTYPE lstp_employee_ID

Primary Identifier

Primary identifier is the most important part of a name. This can be a single word or a phrase. We

will talk of lengths of names later but it is always a trade off between length for documentation and brevity

for typing purposes. We would want to be optimal. This should pretty much tell the reader the purpose of

this identifier. Each corporation should have a list of these prime identifiers in the corporate repository.

Some examples are account, student, company, phone etc.

We will later on discuss some abbreviating rules. A list of abbreviations is also a part of the

corporate repository.

Examples

Account, Student, Company, Phone etc.

Modifier

A modifier further qualifies a primary identifier to make it more readable. These modifiers can

either precede or succeed a primary identifier. Some examples are for the prime id address, modifier may

be mailing forming the name, MailingAddress. Or for Phone it could be, HomePhone etc.

A modifier could also be inserted in the middle of a prime id. For example CustomerName can be

modified to read CustomerLastName.

Examples:

Primary Identifier Modifier Position Variable

address mailing Precede mailing_address

phone home Precede home_phone

customer_name last Middle customer_last_name

Suffix

The suffix is used to qualify the identifier further to document the usage of the variable. For

example, the suffix is used to denote the type of parameter, as in IN, OUT, or INOUT

Type Description Example

i Input only parameter pv_num_items_i

o Output only parameter pv_sum_o

io Both input and output pv_sum_io

Now that some basic standards are defined let us look at how some of these standards are used in

practice.

Some naming and coding standards for PL/SQL – DRAFT – Page 5

剩余25页未读，继续阅读

观想

粉丝: 68
资源: 7

"PLSolutions编码规范：命名与编码标准指南"

Coding Standard

编码规范及其代码.doc

编程规范和范例.doc

rfc3721-iscsi-2004-Naming and Discovery.pdf

cocoon-naming-2.1.5.1.jar

Coding.in.Style.B01C85DTJS

PyPI 官网下载 | naming-0.5.0.tar.gz

PyPI 官网下载 | naming-0.2.0.tar.gz

Python库 | flint-naming-0.2.tar.gz

最新资源