Saltar al contenido

Cree comentarios ABAPDoc en su clase (en las instalaciones)

Los comentarios de ABAPDoc se utilizan para documentar su código. Esto lo hace más legible. Si otros desarrolladores utilizan uno de sus objetos de desarrollo, pueden obtener más información al respecto seleccionando el nombre del objeto en el código y Información del elemento ( F2 )
Todo el tráfico ABAPDoc comienza "!.

Reemplazar siempre XXX o 001 con sus iniciales o número de grupo.


Paso 1: abre tu clase ABAP

Primero, abra su clase ABAP.

Hecho

Inicie sesión para responder la pregunta

Paso 2: agregar un comentario ABAPDoc

Justo antes de definir el método, agregue el comentario ABAPDoc a la clase:
"! Method reads invoice items from database .

NOTA: Debes ingresar un comentario ABAPDoc inmediatamente antes de la declaración; de lo contrario, recibirá una advertencia de ADT.

Imagen que muestra step2-add-abap-doc-comment

Los comentarios de ABAPDoc se pueden utilizar para documentar las API y se muestran en la información del elemento. Todo el tráfico ABAPDoc comienza "! .

Hecho

Inicie sesión para responder la pregunta

Paso 3: agregar parámetros a ABAPDoc

También puede usar ABAPDoc para documentar usando parámetros de método Ayuda rapida. Coloque el cursor dentro del tráfico ABAPDoc. Luego abra el menú de Asistencia rápida usando **Ctrl+1** y haga doble clic en Agregue los parámetros que faltan a la documentación.

Imagen que muestra el paso 3-agregar-parámetros

El tráfico ABAPDoc se expande en un @parameter ... |. Ahora puede usar esto para documentar los parámetros del método: Para hacerlo, simplemente ingrese la documentación después del símbolo de la tubería (|).

Imagen que muestra step3a-parámetros-extra

Hecho

Inicie sesión para responder la pregunta

Paso 4: sincronizar textos cortos

Hemos documentado nuestro método utilizando ABAPDoc. Sin embargo, también nos gustaría ver los mismos textos breves en los campos de informes del Class Builder basado en formularios en SAP GUI.
Para hacer esto, necesitamos etiquetar el texto requerido en el ABAPDoc como «sincronizado» para asegurarnos de que esté sincronizado con Class Builder.

  1. Marque el texto corto de su método en ABAPDoc como «sincronizado» rodeándolo con la etiqueta <p class="shorttext synchronized">...</p>.

  2. Haga lo mismo con el texto corto de sus parámetros lt_result:

Imagen que muestra los textos de sincronización del paso 4

Hecho

Inicie sesión para responder la pregunta

Paso 5: guardar y activar

Salvar ( Ctrl + S. ) y activación ( Ctrl + F3 ) la clase.

Hecho

Inicie sesión para responder la pregunta

Paso 6: enlace al editor

Por último, comprobará que los textos breves sincronizados también se muestran en el Class Builder. Primero necesitamos abrir la clase en SAP GUI.
Para encontrar fácilmente la clase en SAP GUI, primero seleccione Enlace al editor:

Imagen que muestra step6-link-w-editor

Hecho

Inicie sesión para responder la pregunta

Paso 7: Ver los comentarios de ABAPDoc en la GUI de SAP

  1. En el Explorador de proyectos, seleccione la clase ZCL_INVOICE_RETRIEVAL y seleccione Abrir con SAP GUI en el menú contextual:

    Imagen que muestra step7a-open-w-sapgui

  2. La descripción del método que ingresamos en el comentario ABAPDoc en la etiqueta de sincronización muestra:

    Imagen que muestra el texto del método step7b

  3. Ahora seleccione Parámetros. Verá que también se ha sincronizado la descripción del parámetro:

    Imagen que muestra step7b-param-text

  4. Finalmente, cierre la clase en SAP GUI y regrese a su programa ABAP seleccionando Cerrar:

    Imagen que muestra step8-close

Hecho

Inicie sesión para responder la pregunta

Paso 8: conocimiento del elemento de visualización

  1. De vuelta en el programa ABAP, coloque el cursor en el modo de llamada GET_ITEMS_FROM_DB y mostrar la información del elemento del método por selección Información del elemento (F2). Además de la firma del método, también muestra el ABAPDoc que escribió anteriormente:

    Imagen que muestra step8-final-abap-doc

  2. Cierre la información del elemento seleccionando ESC.

Su código de clase ahora debería verse así:


CLASS zcl_invoice_retrieval DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. TYPES: ty_table_of_zso_invoice_item TYPE STANDARD TABLE OF zso_invoice_item WITH DEFAULT KEY. "! <p class="shorttext synchronized">Read items from DB</p> "! Method reads invoice items from the database "! @parameter lt_result | <p class="shorttext synchronized">Table of invoice items</p> "! METHODS get_items_from_db RETURNING VALUE(lt_result) type ty_table_of_zso_invoice_item. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zcl_invoice_retrieval IMPLEMENTATION. METHOD get_items_from_db. SELECT snwd_bpa~company_name, snwd_so_inv_item~gross_amount, snwd_so_inv_item~currency_code, snwd_so_inv_head~payment_status FROM snwd_so_inv_item JOIN snwd_so_inv_head ON snwd_so_inv_item~parent_key = snwd_so_inv_head~node_key JOIN snwd_bpa ON snwd_so_inv_head~buyer_guid = snwd_bpa~node_key INTO TABLE @lt_result WHERE snwd_so_inv_item~currency_code = 'USD' ORDER BY snwd_bpa~company_name. LOOP AT lt_result ASSIGNING FIELD-SYMBOL(<entry>). CASE <entry>-payment_status. WHEN 'P'. <entry>-payment_status = abap_true. WHEN OTHERS. <entry>-payment_status = abap_false. ENDCASE. ENDLOOP. ENDMETHOD. ENDCLASS.

Hecho

Inicie sesión para responder la pregunta

Paso 9: Ponte a prueba

Cree un comentario ABAPDoc para el parámetro PLANETYPE. El texto explicativo debe leerse Type of plane.

Ingrese el comentario en el cuadro de abajo y seleccione Ingresar respuesta.

más información