ESTNDARES DE PROGRAMACIN

Programacin General

1. Las sentencias SQL utilizadas sern escritas en minscula, a excepcin del cdigo SQL generado dinmicamente o aquellas variables que para que puedan ser interpretadas por el compilador deben escribirse en mayscula. i) Ej. set_item_property(GRABAR,ENABLED,PROPERTY_TRUE). 2. Estndares de nombres de variables 1. Las primeras letras de la variable debe indicar a que tipo se trata y debe estar en minscula asi: i) variables: v ii) parmetros: p iii) cursores: c iv) registros: r v) cursores referencia: rc 2. Las tres siguientes letras, en minscula, deben indicar el tipo de dato al que pertenecen en los casos en que sea explicita la declaracin: i) Varchar2 - varchar: var ii) Char: chr iii) Number: num iv) Date: dat 3. A continuacin el nombre de la variable debe proporcionar una idea de su propsito, y debe escribirse la primera letra de cada palabra en mayscula, sin utilizar underscores. 3. Se tratar al mximo que los procedimientos y funciones se encuentren almacenados para buscar reusabilidad. 4. Las asignaciones se escribirn dejando espacio a ambos lados del smbolo de asignacin. Ejemplo: variable := valor 5. La declaracin de variables debe hacerse en el siguiente orden: 1. Variables 2. Cursores 3. Registros 4. Tablas 5. Ref cursors 6. Cuando la variable se requiera para almacenar informacin de tablas existentes en la base de datos, la declaracin del tipo no debe ser explcita, sino que se debe utilizar tabla.columna%type o tabla%rowtype segn sea el caso.

Crear Tablas 1. Existirn varios tipos de tablas cada una de ellas empezar con uno de estos: a. tb: tablas bsicas b. ta: tablas auxiliares c. td: tablas detalles 2. Los nombres de las tablas se realizarn de la siguiente forma: [tipo de tabla][NombreTabla] Para los nombres de las tablas se utilizar el tipo titulo es decir la letra inicial del nombre o nombres (en caso de ser compuesto), con letra mayscula. Adems se omitirn los artculos Ejemplo: tbDocumentos, tbOrdenCompra y NO tbdocumentos o tbOrdendeCompra. 3. Los atributos de las tablas debern ser escritos en minsculas. Adems estos se empezarn a especificar debajo de la palabra table de la primera sentencia SQL. Los tipos de datos y su obligatoriedad debern estar endentados a la izquierda. 4. Se dejar un espacio antes del primer y ltimo parntesis de toda la sentencia. 5. Las sentencias utilizadas para la creacin de las tablas se debe realizar como el siguiente ejemplo: create table tbDocumentos ( fecha date numero number(4) descripcion varchar2(10)

not null, not null, not null );

Alteraciones 1. Las modificaciones que se deseen hacer a las tablas se debern realizar de la siguiente manera: alter table [TipoNombreTabla] Modificacin..... Si la sentencia de la modificacin es ms larga que la lnea, se deber seguir justo donde se empez a digitar est.

Creacin de un Select La creacin de una consulta SQL deber hacerse de la siguiente forma: select .... from .... where condicion 1, condicion 2, condicion 3;

Crear Vistas Para crear una vista se deber tener en cuenta que el nombre de esta deber comenzar con la letra v, que significar vista. Un ejemplo de cmo deber ser es el siguiente: create table vtbDocumentos as select a, b, c from .... where condicion 1; Si la vista es creada por una consulta que utiliza ms de una tabla para ser generada, el nombre de esta deber contener la v de vista ms el tipo de cada una de las tablas y las 3 primeras letras del nombre de cada una de ellas es decir: create table vtbDoctbPro as select ... from ... where ...;

Borrar tablas o vistas Para realizar el proceso de borrado de una tabla y/o vista se deber seguir el siguiente esquema: drop table [nombretabla]; drop view [nombrevista];

Creacin de Alias para las Tablas Para crearle alias a las tablas se utilizaran las primeras letras del nombre de la tabla sin contar el tipo de esta. Ejemplo: select Doc.t, Pro.f from tbDocumentos Doc, tbProveedores Pro where Doc.t = Pro.f;

Insercin de Filas La insercin filas en una tabla determinada se deber de realizar de la siguiente forma: insert into [tipo][NombreTabla] (atributos de la tabla) values (datos);

Borrado de Filas La eliminacin de filas en una tabla determinada se deber realizar de la siguiente forma: delete from [tipo][NombreTabla] where condiciones;

Modificacin de Filas La modificacin de filas en una tabla determinada se deber de realizar de la siguiente forma: update [tipo][NombreTabla] set columna=dato... where condiciones;

Instrucciones if then else Estas instrucciones debern ser escritas de la siguiente forma: - las sentencias debern empezar debajo del inicio de la primera condicin Para instrucciones if simples:

if condicin(es) then sentencias... end if ; Para instrucciones if else: if condicin(es) then sentencias else sentencias end if; Para instrucciones if elsif anidadas if condicin(es) then sentencias elsif sentencias elsif condicin(es) then sentencias end if end if Toda la serie de instrucciones deben estar correctamente endentadas.

Ciclos Estas instrucciones debern ser escritas de la siguiente forma: Para Ciclos simples La secuencia de instrucciones se empezar a digitar debajo de la ultima letra de la sentencia loop. loop secuencia de instrucciones end loop;

Para Ciclos For La secuencia de instrucciones se empezar a digitar debajo del ndice. for indice in ... loop

secuencia de instrucciones end loop;

Para Ciclos While: La secuencia de instrucciones se empezar a digitar debajo del inicio de la primer condicin. while condicion loop secuencia de instrucciones end loop;

Cursores Para declarar un cursor se deber de tener en cuenta lo siguiente: 1. El nombre de este debe estar precedido de la letra c, se escribir todo en minscula y la conformacin de su nombre seguir los estndares de variables indicados al inicio del documento. Ejemplo: cursor cTbDoc is select atributo from ibDocumentos where condicin;

Procedimientos Los estndares que se utilizarn para realizar un procedimiento son los siguientes: 1. El nombre del procedimiento deber estar precedido por la letra p. 2. Al igual que el nombre de las tablas se utilizar el tipo titulo es decir la letra inicial del nombre o nombres (en caso de ser compuesto), con letra mayscula. Ej. pBusMostrarDatos. 3. El nombre del procedimiento debe indicar su funcin. 4. El nombre del procedimiento debe aproximarse a lo que este va a hacer. Por ejemplo si se va a crear un procedimiento para llamar a una forma, lo ms lgico sera que este se llamara pBusLlamarForma. 5. Si el procedimiento tiene parmetros el nombre de estos debern estar precedidos por la letra p, debern estar escritos en minscula y estos deben significar (o lo ms aproximado) la informacin que van a contener. Es decir si se va a enviar como parmetro una fecha, lo correcto es que el nombre este sea pfecha. 6. El cuerpo de este deber estar completamente identado es decir ejemplo:

create or replace parmetros) is declaraciones

procedure[p<categora>NombreProcedimiento](lista

de

begin secuencia de estamentos condicional 1 condicional 2 end condicional 2 end condicional1 secuencia de estamentos exception manejo de excepciones end [pNombreProcedimiento]

Funciones Los estndares que se utilizarn para realizar una funcin son los siguientes: 1. El nombre de la funcin deber estar precedido por la letra f. 2. Al igual que el nombre de las tablas se utilizar el tipo titulo es decir la letra inicial del nombre o nombres (en caso de ser compuesto), con letra mayscula. Ej. fMostrarDatos. 3. El nombre de la funcin debe aproximarse a lo que este va a hacer. Por ejemplo si se va a crear una para calcular un total, lo ms lgico sera que este se llamara fCalcularTotal. 4. Si la funcin tiene parmetros el nombre de estos debern estar precedidos por la letra p, debern estar escritos en minscula y estos deben significar (o lo ms aproximado) la informacin que van a contener. Es decir si se va a enviar cmo parmetro una fecha, lo correcto es que el nombre de este sea pfecha. 5. El cuerpo de este deber estar completamente identado es decir ejemplo: create function [fNombrefuncion](lista de parmetros) return [tipodato] is declaraciones create or replace function fGetLongCad ( pcadena in varchar2) // Los argumentos debern ir uno en cada rengln return number is //dejar un rengln vlong number; votro boolean; //dejar un rengln begin //dejar un rengln

select length(pcadena) into vlong from dual; //dejar un rengln return vlong; //dejar un rengln end fGetLongCad;

Creacin de Trigger de forma Manual Para la creacin de un trigger de forma manual se debe tener el cuenta lo siguiente: 1. El nombre de la funcin deber estar precedido por la letra t. 2. Al igual que el nombre de las tablas se utilizar el tipo titulo es decir la letra inicial del nombre o nombres (en caso de ser compuesto), con letra mayscula. Ej. tAlInsertar.

Formato de fechas

El formato de fechas a utilizar ser el siguiente dd/mm/rrrr hh24:mi. Ej. 15/06/2012

11:51

Documentacin La documentacin de procedimientos y funciones deber realizarse de la siguiente forma:

/*********************************************************************** * Nombre: * Descripcin: * * * * * Variables Locales: Elementos Utilizados: Realizado por: Fecha de Realizacin: Detalles de Modificacin: Versin Fecha Autor --------- ---------- --------------1.0 15/03/2012 crestrepo

Descripcin ------------------------------1. Creacin

************************************************************/

Documentacin para los disparadores: Los disparadores que son generados automticamente por FORMS y no hayan sido modificados por el desarrollador no requerirn de documentacin
/*********************************************************************** * Descripcin: * * * * * Variables Locales: Elementos Utilizados: Realizado por: Fecha de Realizacin: Detalles de Modificacin: Versin Fecha Autor --------- ---------- --------------1.0 15/03/2012 crestrepo

Descripcin ------------------------------1. Creacin

************************************************************/

Objetos de Forms Para los siguientes objetos de Forms deber incluirse un comentario breve en su campo comments de la paleta de propiedades, este comentario debe hacer referencia al objeto de la base de datos que representa, las propiedades o elementos que agrupa:

Alerts Data Blocks Property classes Record Groups Visual attributes