Show TOC

Exporting ABAP Doc CommentsLocate this document in the navigation structure

In SAP NetWeaver 7.5 SP00 or higher, you can export source code documentation of ABAP classes and ABAP interfaces, for example, in order to create a backup of this information for audits.

Context

For each class or interface you can create an html file as follows:

Procedure

  1. Open the Export wizard.

    Here you have the following options:

    • In the Project Explorer, open the context menu in any ABAP project, package, class, or interface and choose Export.

      Note that you can also select several packages, classes, and interfaces.

    • Choose Start of the navigation path File Next navigation step Export End of the navigation path from the menu bar.
    The Export wizard is opened.
  2. In the displayed tree, select Start of the navigation path ABAP Next navigation step ABAP Doc End of the navigation path.
  3. Choose Next.
    The second page is opened.
  4. Choose an ABAP project.

    Here you have the following options:

    • Enter the name of the project in the Project field.
      Tip When editing the project, you can avail of the content assistant functionality by pressing Ctrl + Space.
    • Choose Browse... to search for a specific project.
  5. Choose the ABAP package(s), class(es), or interface(s) you want to export.

    Here you have the following options:

    • To add, choose Add....
    • To remove one or more entries, choose Remove...
    Note The maximum number of objects for one export job is 4000. If the maximum number is exceeded, no ABAP Doc comments are exported and an error is displayed in the export log.
  6. To define the set of members to be exported for classes, select one option in the Visibility of members to be exported area.
  7. To export short texts if no ABAP Doc comment is provided for an element, choose the corresponding checkbox in the Export mode area.
  8. To define the directory where you want to save the export files, choose Browse... in the Destination area.
  9. Choose Finish to start the export.

Results

The export job is started. If you select a package with a huge number of classes and interfaces, for example, the job might last several minutes. You can check the state of the export job in the Console and Progress view.

When the job is finished, the export log is displayed in the Console view. At the same time, a new folder with a unique name is created in the chosen directory. The export files are stored here.

Example
Example of an export file that contains ABAP Documentation
Figure 1: Example of an export file that contains ABAP Documentation

In addition, a popup is displayed from where you can open the export folder directly.

Note To adopt the layout of the exported html file, open and edit the stylesheet.css file. It is saved in the \htmldesign path.
Related Information