Entering content frame

Procedure documentation Documenting and Releasing a Function Module Locate the document in its SAP Library structure

You document your function modules in the Function Builder. There are two kinds of documentation - parameter documentation, and full function module documentation.

Interface Documentation

The parameter documentation must provide users with information about the different parameters and exceptions.

  1. Open the Function Builder and enter the name of the function module that you want to document.
  2. Select Interface.
  3. Choose Change.
  4. Choose the Documentation tab.
    A list of all parameters and exceptions appears.
  5. Enter a short text for each entry.
  6. Save your entries.

Note

To add extra documentation for a parameter or exception, double-click the corresponding line on the Documentation page.
The long text editor appears. Enter your text and save it. You can now return to the function module maintenance screen.

 

Function Module Documentation

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

To create the documentation:

  1. Open the Function Builder and enter the name of the function module that you want to document.
  2. Select Interface.
  3. Choose Change.
  4. Choose Function module doc.
    The system opens the SAPscript editor. Here, you can enter comprehensive function module documentation, including examples, tips for using the function module, and any other relevant information.

    5. This graphic is explained in the accompanying text


    Note

    The SAPscript editor differs considerably from the ABAP Editor. Firstly, the menus and key settings are different. Secondly, you can use special formatting in SAPscript documentation. For further information about the SAPscript editor, see Structure link Text Processing with the SAPscript Editor

  5. Save the documentation

Releasing a Function Module

Releasing a function module is a purely administrative gesture with no effect on the function or its usability. When you are satisfied that a function module is ready for general use, you can release it to the system. Releasing a function module signals that a developer has tested it.

Caution

Remember too, that when you release a function module, its documentation is released for translation and appears in the relevant translator's worklist. You should therefore only release the function module when you are sure that no more changes will occur. It is a good idea to inform your translator in good time that you are releasing your documentation.

Normally, only one person is responsible for a function group and only this user can release the module. Check the attributes for a function group to find out who is responsible for the group. Then, notify this person that your function module is ready for release. To release a function module, choose Function module ® Release options ® Release.

Releasing function modules was designed primarily for developers at SAP. By releasing a function internally, the SAP developer tells other developers at SAP that they can use this particular function module safely. SAP developers can also release their functions for customers. The precise function of an SAP function module may change but SAP ensures that the function remains backwards compatible.

 

 

 

Leaving content frame