✒️ABAP Los Estándares de programación en ABAP

Apuntes Ing Ezequiel Hurtado Benitez.

Estándares de programación, Determinan la forma en la que codificamos los programas ABAP. Es decir, como declaramos las variables, las estructuras, las tablas internas, así como también la forma en que debemos definir los objetos que 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 los programas sean mucho más simples de leer y mantener al momento de tener que realizar una modificación.

Los criterios de un buen estándar de programación, hay muchos estándares de programación que se pueden utilizar. Un buen estándar de programación generalmente considerará los siguientes factores: El factor nemotécnico, para que el programa pueda recordar el nombre de una variable fácilmente se debe seguir alguna regla de tipo nemotécnica; El factor sugestivo, para que otros programadores puedan leer y entender rápidamente nuestro código, el solo nombre de una variable indica o sugiere su uso y finalidad; La consistencia, de modo que utilizamos las mismas convenciones de nomenclatura en todo el programa y hagamos que el texto del código sea "legible".

Ventajas del uso de estándares de programación, 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 que 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 que 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 que seguirá las reglas definidas por el estándar. La utilización de estándares permiten el uso de herramientas automáticas de verificación de nomenclaturas tal como el La verificación ampliada para el programa ABAP o el Inspector de código. Es decir una vez definida el estándar a utilizar, se pueden estas dos herramientas para asegurar la calidad del código, de modo que detecten todos los puntos dentro del código ABAP en donde no se cumple con el estándar definido. (Sin lugar a duda la utilización de la Verificación ampliada de un programa ABAP y el Inspector de código es considerada una buena práctica de programación. Lo ideal es que cada vez que se cree un nuevo programa ABAP, se incluya como un paso necesario dentro de las pruebas unitarias que realiza el programador, la utilización de estas dos herramientas y que se corrijan todos los errores y sugerencias que informan hasta llegar a cero, lo cual es la situación óptima.)

¿Por qué los estándares de programación son utilizados tan poco?, La razón tiene que ver más con los seres humanos que con la tecnología. Veamos a continuación los justificativos mas comunes: Trabajan en un proyecto que no ha adoptado ningún estándar de programación; No los entienden o no los pueden recordar; No ven los beneficios de utilizarlos; Están muy apurados o cansados; Prefieren creatividad y consistencia arbitraria; Piensan que es divertido usar nombres "bonitos" en el código; Son "artistas del Software" y no quieren estar regidos por convenciones. (Todas estas razones que mencionamos por las que no se utilizan los estandartes de programación no son exclusivas de los programadores ABAP sino que aplican para los programadores y las programadoras de cualquier lenguaje.)

Nuestros estándares de programación en ABAP, a continuación te presentamos los estándares de programación que utilizaremos a lo largo de la Carrera ABAP. (Es importante que sepas que dentro de los estándares que definiremos a continuación es probable que mencionemos conceptos que desconoces, pero que iremos incorporando a lo largo de la Carrera Consultor ABAP.) Los estándares que te presento a continuación fueron elaborados en base a la experiencia recopilada en los distintos proyectos en los que he participado como Consultor ABAP y como líder del equipo de desarrollo. Para las declaraciones dentro de un programa ABAP utilizaremos los siguientes estándares: 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_XXXXX; Select Option SO_XXXXXXX; Forms F_XXXXXXXXXXXXXX; Parámetros de un Form P_XXXXX (Cuando hablamos de variables locales, constantes locales o cualquier otra declaración local, nos referimos a aquellas que se realizan dentro de subrutinas. Cuando hablamos de variables globales, constantes globales o cualquier otra declaración global, nos referimos a aquellas que se realizan dentro del programa principal, es decir dentro del evento START-OF-SELECTION.) Para la declaración de los datos que creamos en el Diccionario de datos ABAP utilizaremos los siguientes estándares: Campo nuevo en una tabla base de datos, XXXXXXX Donde XXXXXXX es el nombre del campo nuevo; Elemento de datos, ZZ_XXXXXXX (Donde XXXXXXX es el nombre del campo al que se va a asociar); Dominio, ZDZZZZZZZ (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 se utiliza para describir el nombre de la estructura). Utilizaremos la siguiente nomenclatura para establecer los nombres de los siguientes objetos: Reporte o Programa, ZXXXXX_LEGXXXXEj:ZREPORTE_USUARIOS_LEG1789 Donde LEGXXXX se corresponde al número de legajo; Modulo de Función, ZMFXXXXXXX (Donde XXXXXXX 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 gripo de función); Module Pool o Programa de Diálogo, ZMPXXXXXXX (Donde XXXXXXX se utilizan para describir el nombre 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); 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); 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). 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. A continuación te proponemos una versión de la plantilla de un programa ABAP que puedes utilizar para tus desarrollos:

NOMBRE DEL PROGRAMA

DESCRIPCIÓN: (Descripción breve de la funcionalidad del programa)

NÚMERO DE REQUERIMIENTO: (Nro de requerimiento, mejora o incidencia que genero el desarrollo)

AUTOR: (Nombre y apellidos completos del programa)

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 MODIFICACIÓN: DD/MM/AAAA

DESCRIPCIÓN MODIFICACIÓN: (breve descripción de la modificación)

REPORT ZXXXXXXX.

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, donde XXXX es el nombre del programa)

Include ZXXXX_FORM. (Include de declaración de subrutina, donde 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.