Skip to content

returning-name.md

Latest commit

 

History

History
43 lines (28 loc) · 1.22 KB

returning-name.md

File metadata and controls

43 lines (28 loc) · 1.22 KB
Raw

code pal for ABAP > Documentation > Returning Name

Returning Name

What is the intent of the check?

Suitable method names are usually meaningful enough that the returning parameter does not need a name of its own. The name would do little more than parrot the method name or repeat something equally obvious, so this check reports a finding for all returning parameters that are not named RESULT.

How to solve the issue?

Call all returning parameters RESULT.

What to do in case of exception?

In exceptional cases, you can suppress this finding by using the pseudo comment "#EC RET_NAME which should be placed after the method declaration:

  METHODS get_name
    RETURNING
      VALUE(name) TYPE string. "#EC RET_NAME

Example

Before the check:

  METHODS get_name
    RETURNING
      VALUE(name) TYPE string.

After the check:

  METHODS get_name
    RETURNING
      VALUE(result) TYPE string.

Further Readings & Knowledge