Documente Academic
Documente Profesional
Documente Cultură
DELOSI
Estndar de desarrollo de software
Versin 1.1
____________________
Jefe de Proyectos
Observaciones :
____________________
Gerente de Sistemas
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Historial de Revisiones
Fecha
Versin
Descripcin
Autor
01/12/2010
1.0
Pablo Herrera
07/06/2011
1.1
Pablo Herrera
13/06/2011
1.2
Pablo Herrera
Confidencial
, 2016
Pgina 2
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Tabla de Contenidos
1.
Introduccin
1.1 Alcance
1.2 Herramientas a utilizar
2.
3.
4.
Confidencial
, 2016
7
7
7
8
8
8
8
9
9
10
10
11
11
12
14
14
14
15
15
15
15
Pgina 3
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
4.1.2 Atributos
4.1.3 Vistas
4.1.4 Procedimientos almacenados
4.1.5 Funciones
4.2 Documentacin del cdigo
16
16
17
17
1. Introduccin
El presente documento especifica el estndar de desarrollo de aplicaciones utilizado
para la elaboracin de software en la empresa DELOSI.
1.1Alcance
El presente documento establece las reglas que deben seguir el equipo de desarrollo
y los proveedores al momento de organizar la aplicacin y escribir el cdigo del
sistema. Estos estndares se aplicarn a todo software desarrollado en la empresa.
1.2Herramientas a utilizar
La herramienta de desarrollo es Visual Basic 6.0, esta debe tener el ltimo Service
Pack disponible instalado.
La herramienta para hacer el desarrollo en base de datos es el SQL Server
Management Studio.
Como gestor de base de datos se utiliza Microsoft SQL Server.
Confidencial
, 2016
Pgina 4
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
.
2.2Nomenclatura de objetos
A continuacin se establece los prefijos para los mdulos de desarrollo segn los
cuales se nombrar algunos objetos.
Objeto
Formulario
Prefijo
frm_<Nom_Modulo>_<Nombre>
Clases
Modulo
Control
cls<Nom_Objeto>
mod<Nom_Objeto>
Ctl_<Nom_Objeto>
Ejemplo
frm_FIN_Detraccion
es
clsDetraccion
modPrincipal
ctlMiTextBox
Prefijo
chk
cbo
Cmd
lst
lbl
txt
mnu
opt
pic
pnl
lstVw
trVw
tab
dtp
tmr
pgb
rtb
Ejemplo
ChkSoloEscritura
CboLenguaje
cmdCancelar
LstDestino
LblLocales
TxtEntrada
TnuAbrirArchivo
OptNegritaBold
PicMemoria
PnlCodigos
LstVwUsuarios
TrVwArbol
TabPerfiles
DtpFechaInicio
TmrInciaAlarma
pgbbPorcentaje
RtbParrafo
, 2016
Pgina 5
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
ImageList
ToolBar
StatusBar
Line
img
tlb
stb
lin
ImgDibujo
tlbObsiones
stbAplicacion
linSeleccionado
Prefijos
Bln
Byt
Dte
dbl
int
lng
obj
sng
str
arr
obj
e
Ejemplo
Dim blnMarcado As Boolean
Dim bytValores As Byte
Dim dteFecha As Date
Dim dblCelsius As Double
Dim intEntero As Integer
Dim lngGrande As Long
Dim objControl As Object
Dim sngReales As Single
Dim strCadena As String
Dim arrArray() As Integer
Dim objCliente as new Datacomponent.Cliente
Public Enum eEstadoRegistro
2.5Declaracin de variables
2.5.1
Variables pblicas
Para las variables pblicas a un proyecto se antepondr la letra p junto con el tipo
de dato. Estas variables van dentro de un modulo (Module) el cual ser general en la
aplicacin. Ej.
Public pstrCodigoUsuario as String
Nota. No se deben declarar variables pblicas dentro de las clases, estas deben ser
propiedades que usen variables privadas.
2.5.2
Variables privadas a la clase
Para las variables privadas a la clase se antepondr la letra l junto con el tipo de
dato. Ej.
Private lblnNuevo as Boolean
2.5.3
Variables dentro de procedimientos
Las variables usadas dentro de los procedimientos ya sean pblicos o privados solo
se antepondrn el tipo de dato. Ej.
Confidencial
, 2016
Pgina 6
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
, 2016
Pgina 7
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Confidencial
, 2016
Pgina 8
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Para confirmaciones: Se debe mostrar el mensaje con los botones Si y No, el icono de
pregunta y el ttulo Confirmacin Ej.
MsgBox("Seguro que desea cargar los datos?", vbYesNo + vbQuestion,
"Confirmacin")
Confidencial
, 2016
Pgina 9
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
2.9Consideraciones generales
2.9.1
Del diseo de las pantallas
La aplicacin deber correr sobre un MDI nico, el cual debe tener todas las opciones
en forma de Mens. Los mens sern activados y desactivados segn los permisos
de cada usuario.
El color de fondo de formularios debe ser el estndar de la herramienta de desarrollo.
El tipo de letra utilizado en todo el proyecto deber ser Microsoft Sans Serif en Estilo
de Fuente Normal y tamao 8
El color de texto normal siempre debe ser Negro.
El estndar de los botones de comando es el siguiente:
Botn Normal: Usado para las opciones de aceptar y
cancelar, buscar, etc. Este es el botn estndar.
Medidas Height = 375, Width = 1335. Cuando el texto
supere el ancho del botn se deber cambiar
nicamente el Width.
Botn Grande: Usado en casos especiales cuando se
necesita resaltar las opciones o el diseo de la
pantalla lo amerita. Medidas Height = 615, Width =
1060. Cuando el texto supere el ancho del botn se
deber cambiar nicamente el Width.
2.9.2
Colores permitidos
Los colores recomendados para hacer nfasis en algn dato son: Azul Marino, Rojo
Granate, Amarillo ToolTip adems se podr utilizar Negrita, Cursiva, Subrayado). Bajo
ningn motivo se cambiar color de fondo del control para cumplir con este
cometido.
2.9.3
Los mdulos
resolucin de
este ultimo la
Resolucin de pantalla
que funcionen en las oficinas administrativas debern trabajar en
1024x 768 y para el modulo de punto de venta 800x600 utilizando en
totalidad de la pantalla.
2.9.4
Diseo de mantenimientos
Los mdulos de mantenimiento mantendrn un estndar en funcionalidad y entorno. Se
encontrarn en la carpeta Mantenimiento. Estarn formados por las siguientes ventanas:
, 2016
Pgina 10
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Capa de Data
Cada una de estas capas se encarga de las siguientes tareas.
La Capa de Servicios de Presentacin es responsable de:
Recoger la informacin del usuario
Enviar la informacin del usuario a los servicios de negocio para su procesamiento
Recibir los resultados del procesamiento hecho en los servicios de negocios.
Presentar estos resultados al usuario.
Generalmente esta capa es una pgina ASP con interfaz de usuario.
La Capa de Servicios de Negocios es responsable de:
Recibir lo enviado por la capa de presentacin.
Interactuar con los servicios de Data para ejecutar las operaciones del negocio para
la cual la aplicacin fue diseada (por ejemplo; registrar un documento, procesar una
planilla, etc.)
Enviar los resultados procesados a la capa de presentacin.
La Capa de Data es responsable de:
Recibir los pedidos de data desde la capa de Servicios de Negocio
El almacenamiento de la data.
La recuperacin de la data.
El mantenimiento de la data
La integridad de la Data.
Como reglas se puede entonces tener que:
Nunca la capa de servicios de presentacin accede a la data. Es decir nunca una
pgina ASP llama a un procedimiento almacenado directamente.
Nunca la capa de servicios de negocio accede a la data. Es decir nunca una
componente de la lgica de negocios crea un RecordSet desde una tabla
Se debe tratar siempre de usar Stored Procedures, estos son los que acceden,
agregan, modifican y borran la data.
3.2Consideraciones generales de diseo
3.2.1
Estndar de diseo general
El diseo general de los aplicativos web se debe basar en el prototipo mostrado en la
siguiente figura:
Confidencial
, 2016
Pgina 11
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
, 2016
Pgina 12
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Prefijo
frm_<Nom_Modulo>_<Nombre>
Ejemplo
frm_FIN_Detraccion
es
3.4Nomenclatura de controles
A continuacin se lista la mayor cantidad de controles y sus respectivos prefijos a
utilizar en Visual Basic.
Control
CheckBox
ComboBox
Command
ListBox
Label
TextBox
Menu
RadioButton
PictureBox
Panel
ListView
TreeView
TabControl
DateTimerPicker
Timer
ProgressBar
RichTextBox
ImageList
ToolBar
StatusBar
Line
Prefijo
chk
cbo
Cmd
lst
lbl
txt
mnu
opt
pic
pnl
lstVw
trVw
tab
dtp
tmr
pgb
rtb
img
tlb
stb
lin
Ejemplo
ChkSoloEscritura
CboLenguaje
cmdCancelar
LstDestino
LblLocales
TxtEntrada
TnuAbrirArchivo
OptNegritaBold
PicMemoria
PnlCodigos
LstVwUsuarios
TrVwArbol
TabPerfiles
DtpFechaInicio
TmrInciaAlarma
pgbbPorcentaje
RtbParrafo
ImgDibujo
tlbObsiones
stbAplicacion
linSeleccionado
Prefijos
Bln
Byt
Dte
dbl
int
lng
obj
Ejemplo
Dim
Dim
Dim
Dim
Dim
Dim
Dim
blnMarcado As Boolean
bytValores As Byte
dteFecha As Date
dblCelsius As Double
intEntero As Integer
lngGrande As Long
objControl As Object
, 2016
Pgina 13
DELOSI
Estndar de desarrollo de software
Single
String
Array(Clase)
Objeto
Enum
sng
str
arr
obj
e
Versin:
1.0
Fecha: 03/02/2011
3.6Declaracin de variables
3.6.1
Variables pblicas
Para las variables pblicas a un proyecto se antepondr la letra p junto con el tipo
de dato. Estas variables van dentro de un modulo (Module) el cual ser general en la
aplicacin. Ej.
Public pstrCodigoUsuario as String
Nota. No se deben declarar variables pblicas dentro de las clases, estas deben ser
propiedades que usen variables privadas.
3.6.2
Variables privadas a la clase
Para las variables privadas a la clase se antepondr la letra l junto con el tipo de
dato. Ej.
Private lblnNuevo as Boolean
3.6.3
Variables dentro de procedimientos
Las variables usadas dentro de los procedimientos ya sean pblicos o privados solo
se antepondrn el tipo de dato. Ej.
Dim strCodigo as String
Solo se contempla una excepcin para las variables que son contadores. Ej.
Dim i as Byte
Nota. Se deber usar el tipo de dato Byte para los contadores que no superen 255.
3.7Mtodos
Todos los mtodos deben declararse en verbo presente. Ej.
Public Function Crear() as String
Public Sub Anular()
Los parmetros de los mtodos deben ser lo ms descriptivos posible, no es
necesario colocar el tipo de dato como parte del nombre del mismo, simplemente
que sea entendible. Ej.
Public Function Listar(ByVal CodigoCliente as String, ByVal EstadoCliente as Byte) As
Confidencial
, 2016
Pgina 14
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Dataset
En nuestro caso todos los parmetros deben tener la palabra clave ByVal debido a
que sin esto Visual Basic pasa las variables por referencia que ocupa ms espacio en
memoria.
3.8Documentacin del cdigo
A continuacin se indica cmo es que se debe documentar el cdigo de la aplicacin.
3.8.1
Clases
Todas las clases deben tener una bitcora (como comentario de cdigo) donde se
indique la descripcin, autor y el historial de cambios. Ej.
'Descripcin : Distritos del pas.
'Autor
: Roberto Gutirrez
'Historial
:
'
1. 05/12/2005 | Roberto Gutirrez | Creacin.
Nota. Por cada cambio en la clase, se deber agregar una lnea adicional indicando
todos los datos o una descripcin del cambio realizado.
3.8.2
Propiedades y mtodos
Todas las propiedades y mtodos deben tener una lnea de comentario antes de la
declaracin. En esta se indicar brevemente la funcin que cumple. Ej.
'Cdigo del cliente.
Public Property CodigoCliente As String
3.8.3
Variables
Las variables pblicas y privadas deben estar debidamente comentadas. Ej.
Private lblnNuevo as Bolean
4. Base de datos
4.1Nomenclatura de objetos
4.1.1
Tablas
, 2016
Pgina 15
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
Descripcin
Tabla de bancos
Tabla de cuentas contables
Tabla de empleados
Observaciones:
Los nombres de las tablas debern ser escritas en singular y en maysculas.
De manera obligatoria se debe colocar comentarios a cada campo de la nueva tabla
creada indicando la informacin que debe guardar.
4.1.2
Atributos
El nombre de las columnas para las tablas deber de tener la siguiente estructura:
XXX_YYYYYYYYYY
XXX: corresponde a la naturaleza del dato que contiene la columna ejemplo:
Descripcin
Cdigo de producto
Nmero de pedido
Fecha de registro
Monto total del documento
Indicador de estado del registro
Observaciones:
Los nombres de las columnas debern ser escritas en singular y en maysculas
4.1.3
Vistas
Los nombres de las vistas debern de tener la siguiente estructura:
Confidencial
, 2016
Pgina 16
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
VT_XXX_YYYY
XXX: Mximo 3 caracteres. Es el prefijo del mdulo o aplicacin para el cual se est
creando la vista. Por ejemplo: FIN=Finanzas, CON=Contabilidad RH=Recursos
Humanos.
YYYY: Sin mximo definido. Brinda la informacin sobre la finalidad de la vista.
Ejemplos:
Nombre Campo
VT_FIN_FACTURAS_X_PAGA
R
VT_RH_EMPLEADOS_CESA
DOS
VT_CON_LIBRO_MAYOR
Descripcin
Lista de facturas por pagar
Lista de empleados cesados
Lista el libro mayor
4.1.4
Procedimientos almacenados
Los nombres de los Procedimientos Almacenados en la base de Datos (Store
Procedures) debern de tener la siguiente estructura:
USP_XXX_YYYY
XXX: Mximo 3 caracteres. Es el prefijo del mdulo o aplicacin para el cual se est
creando
el
procedimiento
almacenado.
Por
ejemplo:
FIN=Finanzas,
CON=Contabilidad, RH=Recursos Humanos.
YYYY: Sin mximo definido. Deber de informar la funcin que cumple el
procedimiento almacenado.
Ejemplos:
Nombre Campo
USP_RH_CARGA_EMPRESA_TO
DOS
USP_FIN_REGISTRA_FACTURA
USP_CON_CARGA_CUENTA_UN
O
USP_RH_CARGA_EMPRESA_UN
O
USP_CON_ELIMINA_REGISTROS
Descripcin
Procedimiento que devuelve la lista de empresas
Procedimiento
Procedimiento
contable
Procedimiento
empresa
Procedimiento
Observaciones:
Las descripciones de los procedimientos almacenados debern tener una palabra que
indique la accin que este realiza, por ejemplo: CARGA, REGISTRA, ELIMINA,
ACTUALIZA. Se recomienda el uso de esta lista, pero no es limitante.
4.1.5
Funciones
El nombre para las funciones en la base de datos deber de tener la siguiente
estructura:
FN_XXX_YYYY
Confidencial
, 2016
Pgina 17
DELOSI
Estndar de desarrollo de software
Versin:
1.0
Fecha: 03/02/2011
XXX: Mximo 3 caracteres. Es el prefijo del mdulo o aplicacin para el cual se est
creando
el
procedimiento
almacenado.
Por
ejemplo:
FIN=Finanzas,
CON=Contabilidad, RH=Recursos
YYYY: Sin mximo definido. Deber de informar la funcin que cumple la funcin
creada.
Ejemplos:
Nombre Campo
FN_FIN_RETORNA_COSTO
FN_FIN_CALCULA_VALOR
4.2
Descripcin
Funcin que retorna el costo unitario de un
producto
Funcin que calcula el valor de un tem.
USP_CON_CARGA_CUENTA_UNO IS
Gonzalo Loaiza
01/05/2011
Este sp carga los datos de una cuenta contable
:
1. 12/12/2005 | Gonzalo Loaiza | Creacin.
2.
*/
.....
Confidencial
, 2016
Pgina 18