OracleSource

HEADER ELEMENTS

File Name
Clear, meaningful and descriptive about main objective of the file.
Multiple words are joined using underscores (which adheres to the
file naming standards.
Purpose
Brief description of the functionality of the Code.
Usage
Method of calling the SQL in the prompt to the test the Code.
Date
when the development of the Code was started.
Edit History
History of changes made to the Code. Update Edit History in case
of Change Request to reflect the changes made in the code.
Author (Company Name)
Use standard Boiler Plate given by the client.

Coding Conventions Systematize and Automate
Use code templates to design and make available headers
and structures. Build your checklists into these templates!

Use automated formatters at both the individual and
team levels.
Do not manually format your code. Big waste of time.

General Guidelines while Coding
(i) Standard (space-based) block nesting indentations should be
two spaces
(ii) Avoid Using TABS for indendation, use spaces instead
(iii) All the Keywords of SQL should be in CAPS
(iv) The functional overview comment of a routine should be
indented two spaces. The highest-level statements that
follow the overview comment should be in the same column
as comment, with each nested block indented by two spaces
(v) Adequate blank lines should be left to aid readability of source code
(vi) Proper Indentations should be used when writing PL/SQL
code, like IF and ENDIF , LOOP and END LOOP should line up correctly.
(vii) Use SQL%ROWCOUNT to increment counters after
Insert/Update/Delete statements.
(viii) There should not be more than one expression per line
(ix) A blank line should separate the code and DECLARE/ BEGIN/
EXCEPTION/ END.
(x) The beginning of stored procedure should start with ‘BEGIN’ in
uppercase and end with ‘END’ in uppercase.
(xi) Write consistent Log messages using DBMS_OUTPUT package
detailing the no of rows updated/inserted/deleted in the tables.
(xii) Give inline comments wherever code is changed in case of
CR’s(Client Requests).
(xiii) Application code must raise, handle, log and communicate
errors in a consistent, robust manner.