ABAP Doc parameter names

 home  single file   example  edit

abapdoc_parameter_names

Description

Checks that the parameters documented in ABAP Doc exist in the method definition.

Extended Information

Reports "! @parameter lines in the ABAP Doc block in front of a METHODS or CLASS-METHODS
definition when the parameter is not a parameter of the method, typically after a parameter was renamed or removed.
Also reports a parameter documented twice.

Missing @parameter lines are not reported, documenting parameters is optional. @raising and @exception lines are not checked.

Only the block directly in front of the method is checked, a blank line or a plain comment ends the block,
see rule wrong_abapdoc_position for misplaced ABAP Doc.

Default Configuration

Hover to see descriptions, Ctrl+Space for suggestions

Examples