clean-abap

Clean ABAP

This skill provides comprehensive checking of ABAP code against Clean ABAP principles, based on the Clean ABAP style guide which adapts Robert C. Martin's Clean Code for ABAP.

How to Use This Skill

When checking ABAP code for Clean ABAP compliance:

1. Read the code provided by the user
2. Categorize issues by Clean ABAP sections (Names, Language, Constants, Variables, Tables, Strings, Booleans, Conditions, Ifs, Classes, Methods, Error Handling, Comments, Formatting, Testing)
3. Identify violations with specific line references when available
4. Provide actionable recommendations with code examples showing both the problem and the clean solution
5. Prioritize issues by impact (critical, major, minor)

Check Categories

1. Names

Key Principles:

• Use descriptive names that convey content and meaning
• Prefer solution domain and problem domain terms
• Use pronounceable names
• Use snake_case consistently
• Avoid abbreviations unless necessary
• Use nouns for classes, verbs for methods
• Avoid noise words like "data", "info", "object"
• Pick one word per concept
• Avoid encodings (Hungarian notation, prefixes like iv*, rv*, lt_)
• Avoid obscuring built-in functions

Check for:

• Non-descriptive variable/method/class names (e.g., data1, temp, x)
• Inconsistent abbreviations across the code
• Mixed naming conventions (not snake_case)
• Noise words in names
• Hungarian notation or unnecessary prefixes (iv*, ev*, rv*, lt*, ls_)
• Method names that obscure ABAP built-in functions

2. Language

Key Principles:

• Prefer object orientation to procedural programming
• Prefer functional to procedural language constructs
• Avoid obsolete language elements
• Use design patterns wisely

Check for:

• Use of obsolete statements (unescaped host variables in SELECT, etc.)
• Procedural code that should be object-oriented
• Use of old-style MOVE instead of assignment
• TRANSLATE instead of to_upper()/to_lower()
• CREATE OBJECT instead of NEW
• Old-style READ TABLE instead of table expressions