http://www.blogdesap.com/2012/10/documenta-tus-programas-abap.

html

Documenta tus programas ABAP

Documentar un programa ABAP significa escribir una pequea ayuda para que nuestros
usuarios sepan cul es la funcin del programa. Es adems una pequea gua para saber qu
parmetros son necesarios para la ejecucin correcta del programa y una explicacin de los
posibles errores que nos podemos encontrar. No me refiero a poner pequeos comentarios en
el cdigo ABAP sino a escribir una pequea ayuda visible para los usuarios.
Con todo esto no digo que no est bien explicar nuestras lneas de cdigo, totalmente
necesario, pero tambin hay que pensar en dar las mximas facilidades a aquellas personas
que van a trabajar diariamente con nuestros pequeos programas.
Este tipo de ayuda lo hemos visto ms de una vez en transacciones y programas estndar.
Tomemos por ejemplo, la transaccin FBL5N
Finanzas / Gestion financiera / Deudores / Cuenta / FBL5N Visualizar y modificar partidas
abiertas
Si presionamos el icono i de informacin SAP abre una pequea ventana con informacin
adicional que el usuario puede utilizar para conocer el uso y funcionalidad de la transaccin.

Pasos para generar documentacin en un programa ABAP

Partir de un pequeo programa de prueba que lista los vuelos de una compaa area.
*&-----------------------------------------------------------------------------*
*& 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
**********************************************************************
************
***
SELECTIONSCREEN
***
**********************************************************************
************
SELECT-OPTIONS:
s_carrid
FOR spfli-carrid,
"Compaa area
s_countr
FOR spfli-countryfr.
"Pas de salida

**********************************************************************
***********
*START-OF-SELECTION
**********************************************************************
***********
START-OF-SELECTION.
* Seleccin 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 cdigo escrito vamos a crear la documentacin del programa.

Desde el editor vamos a Pasar a / Documentacin.

Se nos abre un editor (SAPscript o Word segn tengis configurado vuestro sistema)
con los siguientes apartados:
o
Purpose
o

Integration

Prerequisites

Features

Selection

Standard_variant

Output

Activities

Example

Escribimos en cada apartado la informacin que corresponda. Por supuesto, no es

necesario que se escriba informacin en cada apartado.

Guardamos y activamos.

Resultado de la documentacin

Lanzamos nuestro programa bien directamente a travs del editor ABAP o a travs de
la transaccin que hayamos decidido para l.

Marcamos el icono i'.

Un apunte final, si queris traducir vuestra documentacin a otros idiomas podis hacerlo a
travs de la transaccin SE63. As, si el usuario se loga en otro idioma, tambin podr leer la
documentacin que hayis preparado.
Herramientas / Workbench ABAP / Utilidades / Traduccin / SE63 Textos breves y
explicativos
Deberis reccorrer el men Traduccin / Objetos ABAP / Textos explicativos (documentacin) /
Ayuda F1 / RE Reports, gr. funciones, BD lgicas y traducir los textos que os aparezcan.