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".

Before writing, modifying, or reviewing ABAP code, read the abap-code-review-helper skill in full (skip if skill is unavailable), unless its complete contents are already available in your current context. Apply its correctness safeguards alongside these style rules; do not let a style preference change business behavior. Keep passed checks internal.

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.