Show TOC

Synchronizing ABAP Doc CommentsLocate this document in the navigation structure

In SAP NetWeaver 7.5 SP00 or higher, you can synchronize ABAP Doc from descriptions of the Class Builder with the source code editor in ABAP Development Tools (ADT) and vice versa.

Prerequisites

  • The descriptions of components for ABAP classes or ABAP interfaces are entered in the form-based Class Builder of the ABAP Workbench.
  • You can only import and synchronize in the original language.
    Recommendation In accordance with SAP programming guidelines, you should write program comments in English. So you should be logged on in English as your ABAP project language.
  • If ABAP Doc contains special characters such as @ " ! < > - >, you need to replace them by its ACSCII code. Otherwise these special characters are not imported.
  • Short texts may not contain more than 60 characters.

Context

This enables you to keep the documentation of the ABAP source code between ADT and the ABAP Workbench consistent.

Example of short text displayed in transaction SE24
Figure 1: Example of short text displayed in transaction SE24

You have the following possibilities to synchronize changes of ABAP Doc comments in ADT with the Class Builder in the back end:

  • You can surround an ABAP Doc comment with the <p class="shorttext synchronized"> tag in the ABAP source code editor.

    Then, ABAP Doc comments are directly synchronized when you save the corresponding object in ADT.

    Note

    When documenting methods in the definition of ABAP classes, you can use the Add ABAP Doc quick assist for adding the relevant tag as ABAP Doc comment block. For further information, see the Related Information below.

  • You can import ABAP Doc from descriptions from the Class Builder into ADT.

    Then, the <p class="shorttext synchronized"> tag is automatically added to the ABAP Doc comments when you import for the first time. So, the imported ABAP Doc comments are synchronized when you save changes.

Example

Example for providing a short text to be synchronized with the back end in the ABAP source code editor:

"! <p class="shorttext synchronized" lang="en">Short Text to be synchronized with the backend</p>
"!
Related Information