Wrong ABAP Doc position

 home  single file   example  edit

wrong_abapdoc_position

Description

ABAP Doc must be placed directly in front of the declaration it documents.

Extended Information

ABAP Doc documents the single declaration following it, an ABAP Doc block placed
elsewhere is silently ignored, leaving the declaration undocumented.

The following positions are reported,
* in front of a chained keyword, ie. before "CONSTANTS:" instead of after the colon,
* in the middle of a statement, ie. between the parameters of a METHODS definition,
* directly in front of ENDCLASS, ENDINTERFACE or a SECTION statement.

Only checks ABAP Doc inside class definitions and interfaces.

Default Configuration

Hover to see descriptions, Ctrl+Space for suggestions

Examples