clean-abap

Clean ABAP — AI-Optimized Rules

Distilled from the SAP Clean ABAP Style Guide. Licensed under Creative Commons BY 3.0. © SAP SE. Attribution preserved per license terms.

Apply ALL rules below when writing or reviewing ABAP code. Every rule is mandatory unless explicitly marked "consider".

Names

• Use descriptive names that convey meaning. customizing_entries not ce_tab.
• Prefer solution domain terms (queue, tree) in technical layers, problem domain terms (account, ledger) in business layers.
• Use plural for collections: materials not material_tab.
• Use pronounceable names: detection_object_types not dobjt.
• Use snake_case. When hitting length limits, abbreviate the least important words.

  DATA max_response_time_in_millisec TYPE i.
  

• Avoid abbreviations. Use the same abbreviation everywhere for the same concept.
• Use nouns for classes/interfaces, verbs for methods. Prefix boolean methods with is_ or has_.

  CLASS /clean/account.
  METHODS read_entries.
  IF is_empty( table ).
  

• Avoid noise words: account not account_data; user_preferences not user_info.
• Pick one word per concept: always read_*, never mix read_this with retrieve_that.
• Use pattern names (factory, singleton) only if the class actually implements that pattern.
• No Hungarian notation or prefixes. Drop iv_, rv_, lt_, etc.

  " good
  result = a + b.
  " bad
  rv_result = iv_a + iv_b.
  

• Do not shadow built-in functions (condense, lines, strlen, etc.) with method names.

Language

• Verify modern syntax is supported on the target release before using it.
• Do not optimize prematurely. Write clean code first, profile later.
• Prefer OO over procedural. Wrap function modules as thin shells around classes.

  FUNCTION check_business_partner [...].
    DATA(validator) = NEW /clean/biz_partner_validator( ).
    result = validator->validate( business_partners ).
  ENDFUNCTION.
  

• Prefer functional constructs:

  DATA(variable) = 'A'.              " not MOVE
  DATA(uppercase) = to_upper( str ). " not TRANSLATE
  index += 1.                        " not ADD 1 TO
  DATA(obj) = NEW /clean/cls( ).     " not CREATE OBJECT
  

• Use modern table expressions:

  DATA(line) = value_pairs[ name = 'A' ].
  

• Avoid obsolete elements. Use @-escaped host variables in SQL:

  SELECT * FROM spfli WHERE carrid = @carrid INTO TABLE @itab.
  

• Use design patterns only where they provide clear benefit.