Kommentare

Siehe Clean Code.

Kommentare gehören zwingend zu einem professionellen Programm dazu, um den Entwicklern das Verständnis eines Programms zu erleichtern und somit die Wartbarkeit eines Programms zu erhöhen.

Zeilenkommentar

Der * Kommentar steht am Anfang einer Zeile und definiert die gesamte Zeile als Kommentar. Der * Kommentar hat den Vorteil, dass man eine oder mehr Zeilen markieren kann und diese dann gesammelt mit einer Tastenkombination als Kommentar auszeichnen kann, bzw. die Kommentierung wieder entfernen.

Der Nachteil ist, dass der Text hinter dem * nicht automatisch bündig mit den nachfolgenden Zeilen ausgerichtet wird vom Pretty-Printer. Das muss dann manuell vorgenommen werden, um so auch einen optischen Zusammenhang zwischen dem Kommentar und dem nachfolgenden Coding herzustellen.

Der * Kommentar sollte v. a. verwendet werden, um nachfolgenden inhaltlich zusammenhängenden Code einzuleiten.

**********************
* Start-of-Selection *
**********************
start-of-selection.
...

Der " Kommentar

Beim " Kommentar wird alles rechts vom " - Zeichen als Kommentar definiert. Der " Kommentar hat den Vorteil, dass der Text inklusive dem " automatisch bündig mit den nachfolgenden Zeilen ausgerichtet wird vom Pretty-Printer.

Der Nachteil vom " Kommentar ist, dass man nicht eine oder mehr Zeilen markieren kann und diese dann gesammelt mit einer Tastenkombination als Kommentar auszeichnen kann, bzw. wieder entfernen kann. Das müsste dann manuell vorgenommen werden. Bei vielen Zeilen würde dann sicher die Tastenkombination über * bevorzugt werden.

Das muss dann manuell vorgenommen werden, um so auch einen optischen Zusammenhang zwischen dem Kommentar und dem nachfolgenden Coding herzustellen.

Der " Kommentar sollte v. a. verwendet werden, um eine Codingzeile zu beschreiben.

Data: lv_kunnr type vbak-kunnr.    "Kundennummer Kundenauftrag

Literatur

• ABAP Workbench - 100 Tipps & Tricks, von Christian Assig, S. 40ff.