Show TOC

 Documenting and Releasing a Function ModuleLocate this document in the navigation structure

Use

You use this procedure to document function modules in the Function Builder. There are two kinds of documentation: parameter documentation and function module documentation.

Procedure

Creating Interface Documentation

The parameter documentation provides users with information about the different parameters and exceptions in the function module.

  1. In the Object Navigator (transaction SE80), open the function module you want to document.
  2. On the Import, Export, Changing, Exceptions or Tables tab pages, choose the Long Text pushbutton.

    The SAPscript Editor appears.

  3. Enter a short text for each entry.
  4. Save your entries.

Creating Function Module Documentation

Function module documentation contains important information about the functioning of the module. It should be detailed enough for the users to understand the module without having to examine its source code.

  1. In the Object Navigator (transaction SE80), open the function module you want to document.
  2. In the toolbar, choose the Function Module Documentation pushbutton.

    The SAPscript Editor appears.

  3. Enter your text.
  4. Save the documentation.
    Note

    When you release a function module, the documentation is also released for translation and appears in the work list of your translator. We recommend that you inform your translator before releasing such documentation.

Releasing a Function Module

To release a function module, choose Function module → Release → Release.

Note

Check the attributes for a function group to find out who is responsible for the function group. Notify the person responsible when your function module is ready for release. You can also release the function module only internally to other SAP developers.