LOS ESTANDARES DE PROGRAMACION
1. QUE SON LOS ESTANDARES DE PROGRAMACION Y POR QUE ES TAN IMPORTANTE Q LOS UTILICEMOS?
ESTANDARES DE PROGRAMACION
Determinan la forma en la q codificaremos nuestros programas ABAP.
Es decir, como declararemos las variables, estructuras, tablas, así como también la forma en q debemos definir los objetos q creamos en el Diccionario de datos, o en cualquier otra transacción de SAP donde se creen objetos en el sistema.
La utilización de Estándares de Programación es sumamente beneficiosa ya que hace que los programas sean mucho más simples de leer y mantener al momento de tener que realizar una modificación.
2. CRITERIOS DE UN BUEN ESTANDAR
Hay muchos estándares de programación que se pueden utilizar. Un buen estándar de programación generalmente considerará los siguientes factores:
- Factor nemotécnico: para q el programador pueda recordar el nombre de una variable fácilmente.
- Factor sugestivo: para q otros programadores puedan leer y entender rápidamente nuestro código.
- Consistencia: de modo q utilicemos las mismas convenciones de nomenclatura en todo el programa y hagamos q el texto del código sea "legible".
3. VENTAJAS DEL USO DE ESTANDARES
Podemos resumir algunos de los beneficios de utilizar estándares de programación en los siguientes puntos:
- Los nombres de variables serán nemotécnicos con lo q se podrá saber el tipo de dato de cada variable con sólo ver el nombre de la variable.
- Los nombres de variables serán sugestivos, de tal forma q se podrá saber el uso y finalidad de dicha variable o función fácilmente con solo ver el nombre de la variable.
- La decisión de poner un nombre a una variable o función será mecánica y automática, puesto q seguirá las reglas definidas por el estándar.
- Permiten el uso de herramientas automáticas de verificación de nomenclaturas tales como el Chequeo Extendido del Código o el Inspector de Código.
4. POR QUE LOS ESTANDARES DE PROGRAMACION SON UTILIZADOS TAN POCO?
La razón tiene q ver más con los seres humanos q con la tecnología:
- Trabajan en un proyecto q no ha adoptado ningún estándar.
- No los entienden o no los pueden recordar.
- No ven el beneficio de utilizarlos.
- Están muy apurados o cansados.
- Prefieren creatividad y consistencia arbitraria.
- Piensan q es divertido usar nombres "bonitos" en el código.
- Son "artistas del software" y no quieren estar regidos por convenciones.
5. NUESTROS ESTANDARES DE PROGRAMACION
A continuación les presentamos los Estándares de Programación q utilizaremos a lo largo de la Carrera SAP ABAP.
IMPORTANTE: Es importante q sepas q dentro de los estándares q definiremos a continuación es probable q mencionemos conceptos q desconoces, pero q iremos incorporando a lo largo de la Carrera Consultor SAP ABAP.
Para las declaraciones dentro de un programa ABAP utilizaremos los siguientes estándares:
Declaración Se debe escribir de la siguiente forma
Variables Locales VL_XXXXXXXX
Variables Globales V_XXXXXXXX
Checkbox CH_XXXXXXXX
Radio Button RBG11_XXXXXXX, RBG12_XXXXX, RBG1N_XXXX
RBG21_XXXXXXX, RBG22_XXXXX, RBG2N_XXXX
Rangos R_XXXXXXX
Rangos Locales RL_XXXXXX
Constantes Globales C_XXXXXXX
Constantes Locales CL_XXXXXXX
Estructura WA_XXXXX
Estructura Local WAL_XXXXX
Tabla Interna TI_XXXXX
Tabla Interna Local TIL_XXXXX
Tipos TY_XXXXXXXXX
Parámetros P_XXXXXX
Select Option SO_XXXXXXX
Forms F_XXXXXXXXXXXXXX
Parámetros de un Form P_XXXXX
NOTA: Cdo hablamos de Variables Locales, Constantes Locales o cualquier otra declaración local, nos referimos a aquellas q se realizan dentro de subrutinas.
Cdo hablamos de Variables Globales, Constantes Globales o cualquier otra declaración Global, nos referimos a aquellas q se realizan dentro del programa principal, es decir dentro del evento START-OF-SELECTION.
En todos los lenguajes de programación se recomienda generar la mínima cantidad de Variables Globales, ya q consume mucho recursos del sistema. Pero dado q en ABAP no existen problemas de recursos o memoria, no hay inconveniente con la declaración de variables globales.
Para las declaraciones de los datos q creamos en el Diccionario de datos ABAP utilizaremos los siguientes estándares:
Declaración Se debe escribir de la siguiente forma
Campo nuevo en una tabla BD XXXXXXX Donde XXXXXXX es el nombre del campo nuevo
Elemento de datos ZZ_XXXXXXX (Donde XXXXXXX es el nombre del campo al q se va a
asociar)
Dominio ZDXXXXXXX (Donde XXXXXXX deberá referenciar el tipo de datos)
Nombre Tabla ZTXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre de la
tabla)
Estructuras ZXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre de la
estructura)
Utilizaremos la siguiente nomenclatura para establecer los nombres de los siguientes objetos:
Declaración Se debe escribir de la siguiente forma
Reporte o Programa ZXXXXXXX Ej: ZREPORTE_USUARIOS
Modulo de Función ZMFXXXXXX (Donde XXXXXX se utiliza para describir el nombre del
módulo de función)
Grupo de Función ZGFXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre del
grupo de función)
Module Pool o Programa de Dialógo ZMPXXXXXXX (Donde XXXXXXX se utiliza para describir el objetivo del
programa)
Vistas de Actualización ZVAXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre de la
vista)
Clase de Mensajes ZCMXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre de la
clase de mensajes)
Clase de Objetos ABAP ZCLXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre de la
clase)
Clase de Desarrollo o Paquete ZCDXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre de la
clase de desarrollo o paquete)
Ayuda de Búsqueda ZABXXXXXXX (Donde XXXXXXX se utiliza para describir el nombre de la
ayuda de búsqueda)
Objeto de Bloqueo ZOBXXXXXXX (Donde XXXXXXX se utiliza para describir el objetivo del
objeto de bloqueo)
El nombre de un programa ABAP puede tener entre 1 y 30 caracteres de largo, se recomienda no utilizar los siguientes símbolos y signos en los nombres de los programas ABAP: puntos, comas, espacios en blanco, paréntesis, apóstrofes, comillas dobles, asteriscos, el signo igual, caracteres con acentos o el signo de porcentaje.
Para los Encabezados de Programas ABAP
Cuando creamos un programa ABAP nuevo en SAP es recomendable utilizar siempre el mismo encabezado de modo de unificar criterios entre todos los programadores de un mismo proyecto.
Esqueleto de un programa ABAP que se pueden utilizar para los desarrollos.
* NOMBRE DEL PROGRAMA
* DESCRIPCION: (Descripción breve de la funcionalidad del programa)
* NUMERO DE REQUERIMIENTO: (Nro de requerimiento, mejora o incidencia q generó el desarrollo)
* AUTOR: (Nombres y apellidos completos del programador)
* FECHA: DD/MM/AAAA
* CONTROL DE MODIFICACIONES:
* (Esta sección se completa con cada modificación posterior a la implementación en el Ambiente productivo del *programa).
* MODIFICADOR POR: (Nombres y Apellidos del autor de la modificación)
* FECHA MODIFICACION: DD/MM/AAAA
* DESCRIPCION MODIFICACION: (breve descripción de la modificación)
REPORT ZXXXXXX
Más abajo, dentro de la misma plantilla de programa nuevo, especificamos las declaraciones de los Includes, Tipos, Tablas internas, etc.
* INCLUDES
Include ZXXXX_TOP. (Include de declaración de datos, dde XXXX es el nombre del programa)
Include ZXXXX_FORMS. (Include de declaración de subrutinas, dde XXXX es el nombre del programa)
* Definición de TYPES
* Definición de estructuras
* Definición de tablas internas
* Definición de parámetros
* Definición de constantes
* Definición de Ranges
* Definición de variables
* Proceso principal: START-OF-SELECTION
* Acciones de final de proceso: END-OF-SELECTION