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

¿Qué son los Estándares de Programación y por qué es tan importante que los utilicemos?

Los Estándares de Programación determinan la forma en la que se codifican los programas ABAP. Es decir, como se declaran las variables, estructuras, tablas, así como también la forma en que se debe 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 hace que los programas sean mucho más simples de leer y mantener al momento de tener que realizar una modificación.

Criterios de un buen estándar

Un buen estándar de programación generalmente considerará los siguientes factores:

• Factor mnemotécnico: para que el programador pueda recordar el nombre de una variable fácilmente.
• Factor sugestivo: para que otros programadores puedan leer y entender rápidamente nuestro código.
• Consistencia: de modo que se utilicen las mismas convenciones de nomenclatura de todo el programa y asegurar que el texto del código sea "legible".

Ventajas del uso de Estándares

Algunos de los beneficios de utilizar estándares de programación son:

• Los nombres de las variables serán mnemoté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.
• 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.

¿Por qué los Estándares de Programación son utilizados tan poco?

Las razones tienen que ver más con el programador que con las herramientas:

• Trabajan en un proyecto que 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 que es divertido usar nombres "bonitos" en el código.
• Son "artistas del software" y no quieren estar regidos por convenciones.

Nuestros Estándares de Programación

A continuación se presentan los Estándares de Programación que se utilizan en la Carrera 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_XXX
• Variables Globales - V_XXX
• Checkbox - CH_XXX
• Radio Button - RBG11_XX, RBG12_XX...
• Rangos - R_XX
• Rangos locales - RL_XXX
• Constantes globales - C_XXX
• Constantes locales - CL_XX
• Estructura - WA_XX
• Estructura local - WAL_XXX
• Tabla interna - TI_XX
• Tabla interna local - TIL_XX
• Tipos - TY_XXX
• Parámetros - P_XXX
• Select Option - SO_XXX
• Forms- F_XXX
• Parámetros de un Form - P_XX

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 STAR-OF-SELECTION

Para las declaraciones de los datos que 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 base de datos - XXX donde XX es el nombre del campo nuevo
• Elemento de datos - ZZ_XXX donde XX es el nombre del campo al que se va a asociar
• Dominio - ZDXX donde XX deberá referenciar el tipo de datos
• Nombre tabla -ZTXX donde XX se utiliza para describir el nombre de la tabla
• Estructuras - ZXXX donde XX 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 - ZXX ej: ZREPORTE_USUARIOS
• Módulo de Función - ZMFXX donde XX se utiliza para describir el nombre del módulo de función
• Grupo de Función - ZGFXX donde XX se utiliza para describir el nombre del grupo de función
• Module Pool o Programa de Diálogo - ZMPXX donde XX se utiliza para describir el objetivo del programa
• Vistas de Actualización - ZVAXX donde XX se utiliza para describir el nombre de la vista
• Clase de Mensajes - ZCMXX donde XX se utiliza para describir el nombre de la clase de mesajes
• Clase de Objetos ABAP - ZCLXX donde XX se utiliza para describir el nombre de la clase
• Clase de Desarrollo o Paquete - ZCDXX donde XX se utiliza para describir el nombre de la clase de desarrollo o paquete
• Ayuda de Búsqueda - ZABXX donde XX se utiliza para describir el nombre de la ayuda de búsqueda
• Objeto de bloqueo - ZOBXX donde XX 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 les proponemos una versión del esqueleto de un programa ABAP que pueden utilizar para sus desarrollo

Nombre del programa

Descripción : descripción breve de la funcionalidad del programa

Número de requerimiento: nº de requerimiento, mejora o incidencia que genero el desarrollo

Autor: nombres y apellidos completos del programador

Fecha

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

Descripción modificación : breve descripción de la modificación

Report ZXXX

Más abajo, dentro de la misma plantilla de programa nuevo, especificamos las declaraciones de los Includes, Tipos, Tablas internas, etc

INCLUDES

Include ZXX_TOP ( Include de declaración de datos, donde XX es el nombre del programa)

Include ZXX_FORMS ( Include de declaración de subrutinas, donde XX 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 : STAT-OF-SELECTION

Acciones de final de proceso : END-OF-SELECTION