Está en la página 1de 6

SOLUCIONES MARITIMAS S.A.C.

Estndares de Desarrollo

Estndares de Desarrollo
Modelo para un Sistema de Planillas

Ing. Freddy Guzmn Quiroz

Pg. 1

SOLUCIONES MARITIMAS S.A.C.

Estndares de Desarrollo

NOMBRES CORTOS DE SISTEMA Y MODULOS

EMPRESA: SOLUCIONES MARITIMAS S.A.C.


SISTEMA PLANILLAS DE EMPLEADOS : PLAE
Nombre
Corto
PLAE
PLAS
PLAT

Mdulo
01. PLANILLAS DE EMPLEADOS
02. PLANILLAS DE SALARIOS
03. PLANILLAS DE TRIPULANTES

LIBRERIAS

Pueden ser nombradas con un nombre corto de cada Mdulo y ubicarse en


GRUPOSOLMAR: \FUENTES\PB\PLANILLAS
Ejemplo: PLAE.pbl, PLAS.pbl, PLAT.pbl

Las libreras comunes a todos los sistemas se nombrarn colocando el prefijo del
nombre de la empresa seguido del nombre del tipo de objeto que contienen y se
ubicarn en GRUPOSOLMAR: FUENTES\PB\PLANILLAS_COM.
Ejemplo:
SISOLMAR_Applications.pbl, SISOLMAR_DataWindows.pbl, SISOLMAR_Functions.pbl,
SISOLMAR_Menus.pbl,
SISOLMAR_Pipelines.pbl,
SISOLMAR_Projects.pbl,
SISOLMAR_Queries.pbl, SISOLMAR_Structures.pbl, SISOLMAR_User_Objects.pbl,
SISOLMAR _Windows.pbl

Las libreras del sistema de Planillas se nombrarn colocando el prefijo del sistema
global de Planillas seguido del nombre del tipo de objeto que contienen y se ubicarn en
GRUPOSOLMAR: \FUENTES\PB\PLANILLAS
Ejemplo: PLAE_Applications.pbl, PLAE_DataWindows.pbl, PLAE_Functions.pbl,
PLAE_Menus.pbl,
PLAE_Pipelines.pbl,
PLAE_Projects.pbl,
PLAE_Queries.pbl,
PLAE_Structures.pbl, PLAE_User_Objects.pbl, PLAE_Windows.pbl

ESTACIONES DE TRABAJO
Las Estaciones de Trabajo dispondrn de las siguientes Carpetas:

C:\FUENTES\PB\PLANILLAS: Slo tendr las libreras de los mdulos desarrollados


por el programador, las dems libreras de mdulos y las comunes se encontrarn en la
ubicacin indicada en el punto anterior.

C:\FUENTES\PB\ PLANILLAS\MODELOS_DATOS: Archivos del Modelo de Datos del


Sistema de Ventas generados por el programa Erwin, Rational o el que use la empresa.

C:\FUENTES\PB\ PLANILLAS\DOCUMENTOS: Documentos Word, Excel, PowerPoint,


etc. referidos a Manuales Tcnicos, de Usuario, Presentaciones, Cronogramas,
Procedimientos, etc.

Ing. Freddy Guzmn Quiroz

Pg. 2

SOLUCIONES MARITIMAS S.A.C.

Estndares de Desarrollo

BACKUPS
Todos los Archivos de las Estaciones de Trabajo debern ser copiados a su ubicacin
correspondiente en la pc_backup de Archivos al finalizar sus labores diarias.
Soporte Tcnico deber hacer Backup Diario de los archivos del Sistema de Planillas
ubicados en la pc_backup.
NOMBRE DE OBJETOS EN LAS LIBRERIAS

La longitud mxima ser de 40 caracteres.


Objeto
Application
DataWindows
Functions
Menus
Pipelines
Projects
Querys
Structures
Visual User Objects
Non Visual Standard User Objects
Non Visual Custom User Objects
Windows

Prefijo
(ninguno)
d_
f_
m_
pl_
pr_
q_
s_
u_
n_
n_cst_
W_

El nombre estar formado por el prefijo del Objeto ms el nombre corto del mdulo ms
una descripcin.
Ejemplo: w_plae_mant_areas, w_plae_cons_areas, etc.
Esto describe la ventana de mantenimiento de reas del mdulo de planillas.

Ing. Freddy Guzmn Quiroz

Pg. 3

SOLUCIONES MARITIMAS S.A.C.

Estndares de Desarrollo

ESTANDARES SOBRE LA ESTRUCTURA DEL CODIGO FUENTE EN POWERBUILDER


General

En el cdigo no debe tener acentos.

Indentacin del cdigo a 4 espacios. En la definicin de la indentacin del Powerbuilder


se definir la indentacin a 4 posiciones.

Las sentencias o cadenas demasiado largas usarn el carcter de continuacin de lnea.

Todas las estructuras de control (If, For, Do While, Select, With, etc.), debern ser
comentadas.

Toda la codificacin propia del Powerbuilder ser hecha en minsculas.

Las cadenas se concatenarn usando & y no + por fines de claridad y evitar


ambigedades en caso de variantes que contengan nmeros.

Se preferir el uso de sentencias If Elseif, a repetidos anidamientos de If, Else, If.

Cabeceras de Eventos y/o Funciones


En la cabecera de cada evento y/o Funcin se deber indicar los siguientes aspectos:

Todas las variables del mdulo y pblicas debern ser documentadas.

Todo procedimiento o funcin debe contener la siguiente informacin:


Descripcin

Objetivo

Propsito

Qu hace el procedimiento (no cmo).

Parmetros

Cada argumento que pueda no ser obvio. Los


argumentos estn sobre una lnea separada con
comentarios. Se indicar adems si el
parmetro es pasado por referencia, y ser
modificado por el procedimiento invocado.

Salida

Explicacin del tipo y significado de los valores


retornados por las funciones.

Comentarios entre Lneas


Se utilizar para la descripcin de un proceso o segmento en particular de un determinado
bloque de cdigo que requiera una explicacin adicional.

Ing. Freddy Guzmn Quiroz

Pg. 4

SOLUCIONES MARITIMAS S.A.C.

Estndares de Desarrollo

ESTANDARES DE NOMENCLATURA PARA LA BASE DE DATOS

La longitud de nombres de tablas tendrn un mximo de 200 caracteres.

Los nombres de tablas, campos, keys, vistas e ndices sern definidos en letras maysculas.

TABLAS: Plural, usar "underline" para separar palabras (p.ej. EMPLEADOS, AREAS,
INGRESO_CONCEPTOS, COMISIONES_PESCAS). Es necesario definir un nombre corto (4
caracteres) que debemos registrar en la descripcin de la tabla (EMPL, AREA, INCO, COPE).
Descripcin: "Maestro de Empleados - EMPL".

CAMPOS: El ID de la tabla se definir usando el prefijo CODI_ (Cdigo) y luego el nombre corto
de la tabla. Ejemplo: CODI_EMPL, CODI_AREA. Los dems campos sern definidos en singular,
sin artculos y con underline si fuera necesario. Ejemplo: FECHA_INGRESO,
DESCRIPCION_AREA).

KEYS: Usar el nombre corto y el sufijo "_PK" para llaves primarias (EMPL_PK), y el sufijo "_FK"
para forneas (EMPL_ INCO_FK), adems se usar el sufijo _AK para las claves alternativas
especificando una descripcin corta (4 caracteres) del campo de la clave alternativa
(EMPL_DNI_AK) .

VISTAS: Plural, usar "underline", nombre descriptivo (PRESTAMOS_EMPLEADOS Descripcin:


"Vista del nmero de Prstamos por empleados - PREM"), se maneja igual que una tabla, no
interesa conocer si es una vista o no.

INDICES: Usar el nombre corto como prefijo seguido de una descripcin corta (4 caracteres) del
campo o campos que componen el ndice y el sufijo "_IDX". Ejemplo: EMPL_RUC_IDX.

TIPOS DE DATOS
Estndares PowerBuilder
VARIABLES
TIPO DATO
PREFIJO
Any
any
Blob
blb
Boolean
b
Char
ch
Date
d
DateTime
dtm
Decimal
dc
Double
dbl
Integer
i
Long
l
Real
r
String
s
Time
tm
Unsigned
Integer
ui
Unsigned Long
ul
Enumerated
e

Ing. Freddy Guzmn Quiroz

OBJETOS
TIPO OBJETO
Application
DataWindows
Functions
Menus
Pipelines
Projects
Querys
Structures
Visual User Objects
Non Visual Standard User Objects
Non Visual Custom User Objects
Windows

PREFIJO
(ninguno)
d_
f_
m_
pl_
pr_
q_
s_
u_
n_
n_cst_
w_

ALCANCE DE VARIABLES
ALCANCE
Argumento de Evento o Funcin
Variables Globales

PREFIJO
a
g
Pg. 5

SOLUCIONES MARITIMAS S.A.C.


CONSTANTES
Maysculas con separador de
subrayado entre palabras.
Ejemplo:
NOMBRE_BASE_DATOS

Estndares de Desarrollo
Variables de Instancia
Variables Locales
Variables Compartidas (Shared)

i
l
s

OTROS
Arreglos (En singular)

PREFIJO
a

Sintaxis Variables:
Prefijo Alcance de la Variable + Prefijo Tipo de Dato + Nombre de la Variable
Ejemplos:
adc_TopePrimaSeguro

Argumento, Decimal

gs_RazonSocial

Global, String

id_FechaActual

Instancia, Date

li_Valor

Local, Integer

ss_CodigoProveedor

Compartida (Share), String

lai_Documentos(1,n)

Local, Arreglo, Integer

ldbl_MontoReal

Local, Double

lr_Sueldo

Local, Real

Sintaxis Objetos:
Prefijo Tipo de Objeto + Cuatro Letras del Mdulo Destino +Nombre del Objeto
Ejemplos:
Sistema_Planillas

Aplicacin

q_plan_consulta5ta

Query para el mdulo de planillas de nombre Consulta de 5ta. Categora

m_plan_principal

Men para el mdulo de planillas de nombre Principal

w_plan_principal

Windows para el mdulo de planillas de nombre Principal

f_plan_calculo

Funcin para el mdulo de planillas de nombre Clculo

Datawindows
Prefijo Tipo de Objeto + Cuatro Letras del Mdulo Contenedor + Cuatro Letras del Objeto Contenedor+ Nombre del Objeto
Ejemplos:
d_plan_bole_boletas
dddw_plan_bole_empleado

Ing. Freddy Guzmn Quiroz

Datawindows del Mdulo Planillas, de la ventana Boletas y cuyo nombre es Boletas


Dropdown Datawindows del Mdulo Planillas, de la ventana Boletas y cuyo nombre es
empleado

Pg. 6