Clean ABAP

Schluss mit unleserlichen ABAP-Programmen! Dieses offizielle Begleitbuch zum Repository »Clean ABAP« auf GitHub zeigt Ihnen, wie Sie intuitiv verständlichen und leicht zu wartenden Code schreiben. Gespickt mit Best Practices zu Namenskonventionen, Kommentaren und Formatierungen, ist dieser Leitfaden unverzichtbar für den Programmieralltag.

Namenskonventionen, Formatierung, Kommentare u. v. m.

Einleitung ... 171. Einführung ... 231.1 ... Was ist Clean ABAP? ... 231.2 ... Wie kann ich mit Clean ABAP anfangen? ... 261.3 ... Wie gehe ich mit Legacy-Code um? ... 281.4 ... Wie kann ich Code automatisch prüfen? ... 301.5 ... Wie steht Clean ABAP im Verhältnis zu anderen Programmierleitfäden? ... 321.6 ... Wie kann ich mich in der Clean-ABAP-Community engagieren? ... 331.7 ... Zusammenfassung ... 342. Die Programmiersprache ABAP ... 352.1 ... Legacy-Code ... 352.2 ... Performance ... 382.3 ... Objektorientierte vs. prozedurale Programmierung ... 412.4 ... Funktionale vs. prozedurale Sprachkonstrukte ... 492.5 ... Obsolete Sprachelemente ... 522.6 ... Entwurfsmuster ... 542.7 ... Zusammenfassung ... 563. Klassen und Interfaces ... 593.1 ... Objektorientierung ... 593.2 ... Geltungsbereich und Sichtbarkeit ... 903.3 ... Konstruktoren ... 993.4 ... Zusammenfassung ... 1114. Methoden ... 1134.1 ... Objektorientierte Programmierung ... 1134.2 ... Parameter ... 1214.3 ... Methodeninhalt ... 1374.4 ... Methoden aufrufen ... 1484.5 ... Zusammenfassung ... 1535. Namen ... 1555.1 ... Gute Namen ... 1555.2 ... Eigenheiten von ABAP ... 1625.3 ... Affixe: Präfixe, Suffixe und Infixe ... 1635.4 ... Mit Legacy-Code umgehen ... 1665.5 ... Zusammenfassung ... 1676. Variablen und Literale ... 1696.1 ... Variablen ... 1706.2 ... Konstanten ... 1776.3 ... Zeichenketten ... 1866.4 ... Boolesche Ausdrücke ... 1886.5 ... Reguläre Ausdrücke ... 1916.6 ... Das Schlüsselwort REDUCE ... 1936.7 ... Zusammenfassung ... 1967. Interne Tabellen ... 1977.1 ... Die richtige Tabellenart verwenden ... 1987.2 ... DEFAULT KEY vermeiden ... 2007.3 ... Zeilen hinzufügen mit INSERT INTO TABLE und APPEND TO ... 2017.4 ... Prüfen, ob eine Tabelle eine bestimmte Zeile enthält ... 2027.5 ... Tabelleninhalte abfragen ... 2047.6 ... Die Anweisung LOOP AT ... WHERE ... und verschachtelte IF-Anweisungen ... 2067.7 ... Unnötige Tabellenabfragen identifizieren ... 2077.8 ... Tabellenzeilen blockweise und Zeile für Zeile bearbeiten ... 2087.9 ... DESCRIBE TABLE und die Funktion LINES ... 2097.10 ... Zusammenfassung ... 2108. Kontrollfluss ... 2118.1 ... Das Schlüsselwort IF ... 2128.2 ... Schachtelungstiefe ... 2178.3 ... Bedingungen ... 2188.4 ... Das Schlüsselwort CASE ... 2258.5 ... Die Anweisung DO 1 TIMES ... 2298.6 ... Zusammenfassung ... 2339. Kommentare ... 2359.1 ... Präziser Code benötigt keine Kommentare ... 2359.2 ... Kommentare richtig platzieren und verwenden ... 2389.3 ... Kommentare, die Sie vermeiden sollten ... 2399.4 ... FIXME-, TODO- und XXX-Kommentare ... 2429.5 ... Spezielle Kommentare: ABAP Doc, Pragmas und Pseudokommentare ... 2449.6 ... Zusammenfassung ... 24510. Formatierung ... 24710.1 ... Einen konsistenten Stil verfolgen ... 24810.2 ... Den Code fürs Lesen optimieren ... 24910.3 ... Der Pretty Printer ... 25010.4 ... Wie viele Anweisungen pro Zeile? ... 25210.5 ... Zeilenlänge ... 25210.6 ... Code straffen ... 25410.7 ... Leerzeilen ... 25510.8 ... Zuweisungen ausrichten ... 25610.9 ... Variablendeklarationen ausrichten ... 25710.10 ... Wohin mit den Klammern? ... 25710.11 ... Methodenparameter formatieren ... 25810.12 ... Zusammenfassung ... 26311. Fehlerbehandlung ... 26511.1 ... Nachrichten ... 26511.2 ... Rückgabewerte ... 26911.3 ... Ausnahmen ... 27411.4 ... Ausnahmen auslösen und behandeln ... 28411.5 ... Zusammenfassung ... 29112. Unit Tests ... 29312.1 ... Testklassen ... 29412.2 ... Testmethoden ... 30412.3 ... Die getestete Klasse ... 30912.4 ... Namen von Testklassen und -methoden ... 31012.5 ... Assertions ... 31312.6 ... Test-Doubles ... 32512.7 ... Test-Seams ... 33712.8 ... Konzepte zum Umgang mit Unit Tests ... 33912.9 ... Zusammenfassung ... 34313. Pakete ... 34513.1 ... Allgemeine Paketkonzepte ... 34513.2 ... Paketkonzept in ABAP ... 34713.3 ... Optionen für das Paketdesign ... 35313.4 ... Paketprüfungen ... 35813.5 ... Konsequenzen einer mangelhaften oder fehlenden Paketstrategie ... 36713.6 ... Zusammenfassung ... 36814. Wie Sie Clean ABAP umsetzen ... 36914.1 ... Gemeinsames Verständnis der Teammitglieder ... 37014.2 ... Den Broken-Window-Effekt angehen ... 37414.3 ... Code-Reviews und Lernen ... 37814.4 ... Clean Code Advisor ... 38214.5 ... Lerntechniken ... 38214.6 ... Continuous Learning in funktionsübergreifenden Teams ... 38714.7 ... Zusammenfassung ... 390Das Autorenteam ... 391Index ... 393