REVISIÓN 02
SEPTIEMBRE 2024
OBJETO:
Establecer las normas de estilo y convenciones para ser empleado en la codificación metodología para la compilación y generación de nuevas versiones del IG.
RESPONSABILIDADES:
Gerente de Investigación y Desarrollo
- Confeccionar y mantener actualizado el presente instructivo.
Programador
- Aplicar el presente instructivo a desarrollos nuevos como a modificaciones de desarrollos preexistentes, teniendo en cuenta para esta última instancia se aplicará teniendo en cuenta las repercusiones que puede implicar en el correcto funcionamiento y el testeo posterior que deba realizarse.
ABREVIATURAS Y REFERENCIAS:
Software IG GLOBAL IG
DESCRIPCIÓN:
Reglas para definiciones de variables, procedimientos y funciones.
| Variables | Privadas | Publicas | Parámetros | Clases |
| String | vp_s | vf_s | pp_s | m_s |
| Boolean | vp_b | vf_b | pp_b | m_b |
| Integer | vp_i | vf_i | pp_i | m_i |
| Long | vp_l | vf_l | pp_l | m_l |
| Double | vp_d | vf_d | pp_d | m_d |
| Object | vp_ob | vf_ob | pp_ob | m_ob |
| Currency | vp_c | vf_c | pp_c | m_c |
| Formularios | Globales | |||
| Procedimientos | pf_ | pg_ | ||
| Funciones | ff_ | fg_ |
Reportes (Crystal Reports)
Los archivos de reportes (Crystal) deben tener los siguientes márgenes:
- Derecho: 1cm.
- Izquierdo: 1,5cm.
- Superior: 1cm.
- Inferior: 1cm.
Esta norma no es aplicable a los formularios personalizados de clientes.
Reportes (DevExpress)
Los archivos de reportes deben heredar del reporte base Reporte_Base obteniendo los márgenes y estilos por defecto de manera unificada para todos los reportes a realizar.
Esta norma no es aplicable a los formularios personalizados de clientes.
Formularios (Forms de Visual Basic)
Generalidades
- Tener presente la correcta visualización de las ventanas utilizando el skin estándar del Sistema Operativo.
- Deshabilitar el botón maximizar de la ventana.
Ubicación de los botones
- Para los botones comunes (grabar, limpiar, barrido de registros, salir, etc.), se ubicarán en la parte inferior del formulario alineados a derecha horizontalmente.
- Para botones específicos que llamen a otras ventanas o ejecuten funciones específicas del formulario, se ubicarán verticalmente a la derecha del formulario.
IGGLOBAL Online
Cliente
- Módulos:
- Cada módulo del sistema debe estar representado por los archivos modulo.module.js y modulo.config.js dentro de una carpeta con el nombre del módulo en cuestión.
- Servicios:
- Dentro de la carpeta de módulo, los servicios deberán estar contenidos en una carpeta cuyo nombre represente la entidad asociada y el archivo deberá tener el sufijo service. Ejemplos: CRM/Eventos/eventos.service.js
- Controladores:
- Dentro de la carpeta de módulo, los controladores deberán estar contenidos en una carpeta cuyo nombre represente la entidad asociada y el archivo deberá tener el sufijo controller. Ejemplos: CRM/Eventos/eventos.controller.js (explorer), CRM/Eventos/evento.controller.js (formulario)
- Formularios:
- Todos los formularios deberán tener un elemento form con la clase form-horizontal, nombre form y el atributo novalidate
- El elemento form debe estar contenido en la siguiente jerarquía para soportar responsive:
<div class=”wrapper wrapper-content”>
<div class=”row animated fadeIn”>
<div class=”col-lg-12″>
<div class=”ibox float-e-margins”>
<div class=”ibox-title”>
<h5>…</h5>
</div>
<div class=”ibox-content”>
<form method=”get” class=”form-horizontal” name=”form” novalidate>
</form>
</div>
</div>
</div>
</div>
</div>
- Dentro de los formularios deberán utilizarse los controles definidos en FormHelpers para diseñar la pantalla.
- Se deberá diseñar el formulario con al menos una sección.
Servidor
- Nomenclatura de acciones: los identificadores de acciones deben de estar formados por abreviatura de la gestión–número correlativo según abreviatura de gestión. Ejemplos: MK-23, GR-71, DD-31
- La generación de SP y Entidades deberá realizarse con la herramienta Aperture.
Reportes (DevExpress)
- Todos los reportes deberán heredar de ReporteBase para recibir funcionalidades comunes como traducción, conectividad a base de datos y seguridad.
|
CONTROL DE CAMBIOS PARA LA REVISIÓN ACTUAL |
||
|
Ubicación |
Motivo del cambio |
Descripción del cambio |
| Descripción | Mejora | Se agregó Reportes DevExpress |