Documenta tus programas ABAP

Documentar un programa ABAP significa escribir una pequeña ayuda para que nuestros usuarios sepan cuál es la función del programa. Es además una pequeña guía para saber qué parámetros son necesarios para la ejecución correcta del programa y una explicación de los posibles errores que nos podemos encontrar. No me refiero a poner pequeños comentarios en el código ABAP sino a escribir una pequeña ayuda visible para los usuarios.

Con todo esto no digo que no esté bien explicar nuestras líneas de código, totalmente necesario, pero también hay que pensar en dar las máximas facilidades a aquellas personas que van a trabajar diariamente con nuestros pequeños programas.

Este tipo de ayuda lo hemos visto más de una vez en transacciones y programas estándar. Tomemos por ejemplo, la transacción FBL5N

Finanzas / Gestion financiera / Deudores / Cuenta / FBL5N – Visualizar y modificar partidas abiertas

Si presionamos el icono ‘i’ de información SAP abre una pequeña ventana con información adicional que el usuario puede utilizar para conocer el uso y funcionalidad de la transacción.

Pasos para generar documentación en un programa ABAP

Partiré de un pequeño programa de prueba que lista los vuelos de una compañía aérea.

*&------------------------------------------------------------------------------*
*& Report  ZPRUEBA                                                              *
*&                                                                              *
*& Listado de vuelos                                                            *
*********************************************************************************
REPORT  zprueba NO STANDARD PAGE HEADING LINE-SIZE 255.
*
*********************************************************************************
*Tablas
*********************************************************************************
TABLES:
  spfli.                                      "Itinerario de vuelos
*********************************************************************************
*Tipos
*********************************************************************************
TYPES:
  ty_spfli TYPE SORTED TABLE OF spfli WITH NON-UNIQUE KEY carrid connid.


*********************************************************************************
*Variables globales
*********************************************************************************
DATA:
  ti_spfli TYPE ty_spfli WITH HEADER LINE.   "Tabla interna de vuelos


**********************************************************************************
***                            SELECTION-SCREEN                                ***
**********************************************************************************
SELECT-OPTIONS:
  s_carrid     FOR spfli-carrid,            "Compañía aérea
  s_countr     FOR spfli-countryfr.         "País de salida


*********************************************************************************
*START-OF-SELECTION
*********************************************************************************
START-OF-SELECTION.

* Selección de vuelos
  SELECT *  FROM spfli
    INTO CORRESPONDING FIELDS OF TABLE ti_spfli
    WHERE ( carrid    IN s_carrid
      AND   countryfr IN s_countr ).


*********************************************************************************
*END-OF-SELECTION
*********************************************************************************
END-OF-SELECTION.

* Listado

  LOOP AT ti_spfli.
    WRITE: / ti_spfli-connid,
             ti_spfli-cityfrom,
             ti_spfli-deptime.
  ENDLOOP.

Una vez tenemos el código escrito vamos a crear la documentación del programa.

• Desde el editor vamos a Pasar a / Documentación.
• Se nos abre un editor (SAPscript o Word según tengáis configurado vuestro sistema) con los siguientes apartados:
  • Purpose
  • Integration
  • Prerequisites
  • Features
  • Selection
  • Standard_variant
  • Output
  • Activities
  • Example
• Escribimos en cada apartado la información que corresponda. Por supuesto, no es necesario que se escriba información en cada apartado.
• Guardamos y activamos.

Resultado de la documentación

• Lanzamos nuestro programa bien directamente a través del editor ABAP o a través de la transacción que hayamos decidido para él.
• Marcamos el icono ‘i'.

Un apunte final, si queréis traducir vuestra documentación a otros idiomas podéis hacerlo a través de la transacción SE63. Así, si el usuario se loga en otro idioma, también podrá leer la documentación que hayáis preparado.

Herramientas / Workbench ABAP / Utilidades / Traducción / SE63 – Textos breves y explicativos

Deberéis reccorrer el menú  Traducción / Objetos ABAP / Textos explicativos (documentación) / Ayuda F1 / RE Reports, gr. funciones, BD lógicas y traducir los textos que os aparezcan.

Imagen inicial | quinn.anya

¿Te ha gustado este artículo? Ayúdame a que llegue a más gente compartiéndolo :-)