Estándares de Codificación Acatuales
Introducción
El presente documento tiene como finalidad establecer las convenciones de estandarización que permitan una escritura uniforme de código, así como la declaración de variables, creación de campos, tablas, etc.
Estándares de Módulos
Los módulos y submódulos se crearán bajo las siguientes reglas:
· Los programas se darán de alta de acuerdo a las necesidades del sistema y en un esquema ordenado, habrá una sección para: catálogos, utilerías, reportes, módulo 1, módulo 2, etc.
· Con el fin de recordar rápidamente que tablas pertenecen a que módulos y submódulos, se utilizará como prefijo dos letras mayúsculas consecutivas, la primera indicando el módulo y la segunda el submódulo.
La siguiente tabla ejemplifica algunos prefijos:
| Módulo | Submódulo | Prefijo |
| Personal de Abordo | Reclutamiento | PR |
| Planeación y Servicios | Asignación de Viajes | SV |
| Control Central | Catálogos Generales | CC |
| Liquidación de Conductores | Cuentas por Pagar | LP |
Nota: La designación de otros prefijos se designarán conforme avance en el proyecto.
Estándares en Tipos de Datos
Los tipos de datos se crearán bajo las siguientes reglas:
- Los tipos de datos serán dados de alta en orden alfabético.
- Si alguna variable virtual es declarada y es de propósito muy particular en algún programa de utilería (contador, bandera, etc.), la variable no utilizará un tipo de dato, por el contrario, este será especificado en la misma tarea.
- Si el nombre del tipo de dato es compuesto, las palabras se escribirán en forma continua (sin espacios), donde la primer letra de cada uno será en mayúscula.
Estándares en Tablas
Las tablas se crearán bajo las siguientes reglas:
- Al igual que los módulos, las tablas se darán de alta de acuerdo a las necesidades del sistema y en un esquema ordenado, habrá una sección para: catálogos, utilerías, reportes, módulo 1, módulo2, etc.
- Se construirá con el prefijo del módulo al que pertenece y un guión bajo seguido de la descripción correspondiente (acentos, eñes o cualquier carácter extendido). Si el nombre de la tabla es compuesto, las palabras se escribirán en forma continua (sin espacios), donde la primer letra será en mayúscula, por ejemplo: VT_BoletosActivos.
Estándares en Campos de una Tabla
Los campos de tablas se crearán bajo las siguientes reglas:
· Cada campo se construirá con el prefijo del módulo, seguido de tres caracteres en minúscula que describan el nombre de la tabla, un guión de subrayado, un carácter alfabético en minúscula que identifica el tipo de dato e inmediatamente después la descripción del campo.
· Si el nombre del campo es compuesto, las palabras se escribirán en forma continua (sin espacios), donde la primer letra de cada uno será en mayúscula. Por ejemplo: el campo Folio impreso de la tabla Boletos Activos quedará de la siguiente manera: VTboa_nFolioImpreso.
La siguiente tabla lista los prefijos para los diferentes tipos de dato:
| Tipo de dato | Abreviación |
| Numérico | N |
| Alfanumérico | A |
| Fecha | F |
| Hora | H |
| Lógico | L |
| Memo | M |
Estándares en Campos de Auditoria
En la mayoría de las tablas del sistema se colocará un conjunto de campos que indiquen quién, cuando, a que hora, desde que oficina y desde que terminal (equipo de cómputo) se creó o modificó un registro. A este grupo de campos se les conoce como “campos de auditoria”.
Los campos de auditoria se crearán bajo las siguientes reglas:
- Se escribirán como un nombre de campo ordinario, agregando tan solo la abreviación Au inmediatamente después del carácter que especifica el tipo.
- Si el nombre del campo es compuesto, las palabras se escribirán en forma continua (sin espacios), donde la primer letra de cada uno será en mayúscula.
La siguiente tabla lista los campos de auditoria:
| Campos de Auditoria |
| VTboa_fAuFecha |
| VTboa_hAuHora |
| VTboa_nAuClaveTerminal |
| VTboa_aAuClaveOficina |
| VTboa_aAuClaveUsuario |
Si se necesita especificar más de una acción por registro se sustituye “Au” por una abreviatura de la acción. Por ejemplo:
| Acción | Abreviación |
| Creación | Cr |
| Cancelación | Ca |
| Revisión | Re |
| Impresión | Im |
| Transferencia | Tr |
Estándares en Nombres de Variables
Las variables virtuales y parámetros se crearán bajo las siguientes reglas:
· En la tarea de ambiente o en su defecto, sobre la primer tarea del programa; se declararán las variables generales.
· Cada variable se declarará iniciando con la letra “V”.
· Por lo que se refiere a los parámetros, se iniciará con la letra “E” de entrada ó “S” de salida, sustituyendo a la “V”.
· Para las variables que se utilizan para los botones la “V” se sustituirá por “B”.
· En todos los casos se escribirá después de la primera letra un carácter de subrayado, un carácter alfabético en minúscula para indicar el tipo dato y finalmente la descripción de la variable. Ejemplos: V_aClaveOficina y E_nCodigoTap.
· No se trabajará directamente con variables reales, se utilizarán virtuales. Esto es con el fin de evitar inconsistencia de datos y un manejo concurrente que afecte el desempeño de la aplicación.
Estándares en Programas y Tareas
Los programas y tareas se crearán bajo las siguientes reglas:
· La primer tarea de cada programa llevará un prefijo que ayudará a identificar su función dentro de la aplicación, la siguiente tabla muestra la lista de dichos prefijos:
| Prefijo | Descripción |
| Primario | P |
| Secundario | S |
| Lanzador | L |
| Utilería | U |
· Las tareas serán identificadas con un prefijo, a fin de saber el modo en el que se ejecutan. La siguiente tabla lista los prefijos y su significado (modo) correspondiente:
| Modo | Abreviación |
| OnLine | O |
| Delete | D |
| Create | C |
| Modify | M |
| Write | W |
| Query | Q |
Por ejemplo (con base en las tablas anteriores): el programa calendario quedaría como: UO_Calendario, el programa que manda llamar el catálogo de proveedores en modo consulta quedaría como: LQ_Proveedores.
· Cuando se necesite crear o modificar algún registro, se creará una tarea para tal fin.
· La propiedad “habilitado” en los botones, será utilizada siempre y cuando, el botón tenga algún propósito dentro del programa.
· La propiedad “visible” en los botones, será estrictamente relacionada con el modo de operación del programa.
Estándares en Formas
Las formas (pantallas de usuario) se crearán bajo las siguientes reglas:
- Las aplicaciones se desarrollarán para una resolución de 800 X 600.
- Es responsabilidad del desarrollador centrar la forma en la pantalla, a menos que está tenga que estar en un posición diferente, porque el módulo así lo exija.
- Los colores utilizados en la forma (fondo, letras, controles, etc.) Serán aquellos que nos indique la carpeta Support ubicada en el servidor, y que es leída desde el archivo INI. Así mismo, todo lo que se menciono anteriormente debe ser configurable desde el entorno de Windows. No se crearán colores fijos.
- El título de las ventanas será escrito de acuerdo al módulo que se este desarrollando. La primer letra de cada palabra será escrita con mayúscula y las siguientes con minúsculas, por ejemplo: Catálogo de Autobuses, Alta de Empleados, Configuración de Terminales.
- Los mensajes de error o advertencia se manejarán con la ayuda de un programa que despliegue ventanas de diálogo. Lo anterior sólo aplica a mensajes sumamente importantes, los demás serán desplegados en la barra de estatus.
- El título de los cuadros de diálogo será el mismo que tendrá el programa que la manda llamar, separado por un guión y especificando si es un Error o una Advertencia. Por ejemplo: Error - Alta de Empleados, Advertencia - Configuración de Terminales.
- Será en los cuadros de diálogo donde se de una descripción concreta de que tipo de error o cual advertencia se está describiendo.
- En los posible, se utilizarán programas modulares que faciliten la programación. Por ejemplo: un calendario, una calculadora, ventanas de diálogo, etc.
- En programas tipo “bach”, se utilizará algún tipo de programa que indique el procesamiento de datos. Por ejemplo: una barra de progreso.
Estándares en Documentación de Programas
Todos los programas serán documentados, esto con el fin de que su mantenimiento sea fácil y en el menor tiempo posible.
La documentación de programas se hará bajo las siguiente reglas:
· En la tarea de ambiente o en su defecto, sobre la primer tarea del programa; se creará:
o Descripción breve pero clara del programa.
o En caso de manejar parámetros, describir los parámetros de entrada y de salida.
· Después se integrará las líneas de una bitácora. La cual, será integrada con los siguientes elementos:
o Autor.
o Fecha.
o Descripción de la modificación.
· Para cada constante o variable que se declare, deberá hacerse una descripción de su uso.
Nota: En la bitácora se registrará toda modificación importante que se haya hecho al programa.
No hay comentarios:
Publicar un comentario