ABAP Code-Vorlagen – Code-Vorlagen

Jeder ABAP-Entwickler sollte mit ABAP Code-Vorlagen arbeiten. Das erleichtert die tägliche Arbeit enorm. Du kannst Dich mehr auf das ABAP-Programmieren konzentrieren, anstatt immer wieder die typischen und immer gleichen Anweisungen bzw. Kommentare einzufügen. Sie sind ein Muss für jeden ABAP-Entwickler. Mit Code-Templates kann man einfach schön formatierte Kommentare verwenden.

Wenn Du Dir die ABAP Code-Vorlagen zum ersten Mal genauer ansiehst, wirst Du feststellen, dass es bereits einige im Standard gibt, die Du verwenden kannst. Du hast aber auch die Möglichkeit, eigene ABAP Code-Vorlage zu erstellen.

In diesem Artikel stelle ich Dir die ABAP Code-Vorlagen im Detail vor. Ich erkläre Dir, was ABAP Code-Vorlagen sind, welche Voraussetzungen für die Nutzung wichtig sind und wie Du Code-Vorlagen aufrufen und pflegen kannst. Außerdem liste ich Dir abschließend die wichtigsten Parameter auf, die Du bei der Definition von Code-Vorlagen verwenden kannst.

Was sind ABAP Code-Vorlagen?

Eine ABAP Code-Vorlage (ABAP Code-Template) ist ein ABAP-Code, den man durch Verwendung einer ID im SAP Editor einfach einfügen kann. Anstatt einen ABAP-Code manuell einzugeben, reicht es aus, nur die ID einzugeben, die TAB-Taste zu drücken und automatisch wird der gespeicherte Code eingefügt.

ABAP Code-Vorlagen eignen sich hervorragend für die Verwendung häufig verwendeter ABAP-Anweisungen wie bswp. Kommentare, IF-Else-Bedingungen und WHILE-Schleifen.

Eine ABAP-Code-Vorlage besteht aus drei Eigenschaften:

• Name
• Beschreibung
• Code

Voraussetzungen für ABAP Code-Vorlagen

Damit Du die ABAP Code-Vorlagen im SAP Editor nutzen kannst, musst Du den quellcode-basierten Editor verwenden. Du kannst zwischen zwei Editoren wählen:

• Quellcode-basierter Editor
• Text-basierter Editor

In den benutzerspezifischen Einstellungen kannst Du den quellcode-basierten Editor auswählen. Dafür rufst Du die Menufunktion „Hilfsmittel > Einstellungen“ auf und wählst im Tabreiter „ABAP Editor > Editor“ die Option „Quellcode-basierter Editor“. Mit der Enter-Taste oder dem Übernehmen-Button bestätigst Du Deine Eingabe.

Damit Deine Änderungen wirksam werden, musst Du den SAP Editor neu aufrufen. Hierfür gibst Du entweder den Transaktionscode (SE24, SE37, SE38, SE80, usw.) im Kommandofeld noch einmal ein und rufst Dein Programm erneut auf oder Du gehst einen Schritt zurück (F3-Taste) und gehst erneut in den Änderungsmodus Deines ABAP-Programms.

ABAP Code-Vorlagen aufrufen

Jede ABAP Code-Vorlage hat eine ID oder einen Namen. Um die ABAP Code-Vorlagen zu verwenden, gibst Du im SAP Editor die ID oder den Namen der Vorlage ein. Für einige Sekunden erscheint darüber ein Rahmen mit der Beschreibung. Mit der TAB-Taste oder der Tastenkombination „Strg + Enter“ kannst Du nun die ABAP Code-Vorlage nutzen. Wenn keine Parameter gepflegt sind, wird der Quellcode direkt eingefügt. Ansonsten erscheint für jeden Vorlagenparameter ein PopUp, in dem Du den Wert des Parameters eingeben kannst.

Beachte, dass Du die Vorlage nur solange verwenden kannst, wie der Rahmen mit der Beschreibung sichtbar ist. Wenn Du zu lange wartest, verschwindet der Rahmen und Du kannst die Vorlage nicht mehr mit der Tabulatortaste nutzen. Gib einfach die ID erneut ein, so dass der Rahmen erscheint und drücke die Tab-Taste oder die Tastenkombination „Strg + Enter“, um die Vorlage zu nutzen.

Pflege von ABAP Code-Vorlagen

Im SAP Editor (Transaktion SE24, SE37, SE38, SE80, usw.) gelangt man über den entsprechenden Button ganz unten rechts zu den Optionen in der SAP GUI und damit zu den Code-Vorlagen.

Wenn Du den entsprechenden Button drückst, öffnen sich die Optionen. Hier kannst Du einfach den Knoten „Code-Vorlagen“ auswählen. Hier kannst Du ABAP Code-Vorlagen pflegen. Insgesamt hast Du drei Möglichkeiten für die Pflege von ABAP Code-Vorlagen:

• Hinzufügen
• Bearbeiten
• Löschen

Mit dem entsprechenden Button löst Du die Aktion aus.

Bei der Erstellung einer Code-Vorlage gibst Du den Namen und die Beschreibung an. Anschließend kannst Du im Bereich „Code:“ den gewünschten Code eingeben.

Möchtest Du den Namen oder die Beschreibung ändern, wählst Du die Vorlage aus und klickst anschließend auf den Button „Bearbeiten…“. Dann kannst Du den Namen oder die Beschreibung ändern. Möchtest Du den Code ändern, reicht ein Klick auf die Vorlage und Du kannst direkt im Bereich „Code:“ den Code verändern. Nach der Änderung kannst Du Deine Eingaben übernehmen, indem Du auf den „Sichern“-Button klickst.

Eine Vorlage kannst Du löschen, indem Du diese auswählst und auf den Button „Löschen…“ klickst.

Die wichtigsten Parameter in Code-Vorlagen

Mit dem Button „Tag einfügen…“ kannst Du Standardparameter in Deinen Code einfügen und verwenden. Entweder drückst Du diesen Button und wählst die Option aus oder Du gibst den Parameter direkt im Bereich „Code:“ ein.

Es stehen hierfür folgende zur Auswahl:

Name	Parameter	Beschreibung
Cursorpositon	|	Position des Cursors
Datum Uhrzeit	%DateTime%	Datum und Uhrzeit
Zwischenablage	%Clipboard%	Zwischenablage wird eingefügt
Zu umgebender Text	%SurroundedText%	Markierter Text mit Code umgeben
Dokumentname	%Document%	Reportname
Interaktiv	%Variable name%	Eigenen Parameter, beim Aufruf wird Wert eingegeben

Cursorsposition

Der Parameter | im Code setzt den Cursor an diese Stelle. Das Zeichen verschwindet und erscheint nicht mehr im Code. Dies ist besonders praktisch, da man direkt nach der Verwendung der Codevorlage die Cursorposition festlegen und mit der Programmierung fortfahren kann.

Datum Uhrzeit

Mit dem Parameter %DateTime% können Datum und Uhrzeit eingefügt werden. Das aktuelle Datum und die aktuelle Uhrzeit werden eingefügt. Ein Beispiel wäre „11.05.2023 10:14:20“.

Leider ist es nicht möglich, nur das Datum oder nur die Uhrzeit zu verwenden. Dies wird leider nicht unterstützt. Wenn man also nur %Date% oder %Time% verwendet, wird dies als eigener Parameter interpretiert und man kann den Parameter durch ein PopUp mit einem Wert ersetzen bzw. füllen.

Zwischenablage

Der Parameter %Clipboard% fügt den Inhalt der Zwischenablage ein. Wenn zuvor mit der Tastenkombination „Strg + C“ etwas in die Zwischenablage kopiert wurde, wird dieser Wert mit dem Parameter %Clipboard% eingefügt.

Zu umgebender Text

Der Parameter %SurroundedText% ermöglicht das Einfügen von Code um einen markierten Text herum.

Der Beispielcode für die Anweisung try-catch sieht wie folgt aus:

TRY.
%SurroundedText%
CATCH |.

ENDTRY.

Um nun die Code-Vorlage nutzen zu können, musst Du ein Wort oder Satz markieren. Anschließend klickst Du mit der rechten Maustaste auf das markierte Wort und wählst „Format > Mit Vorlage umgeben > Try“. Anstelle von Try kannst Du natürlich Deine eigene Code-Vorlage auswählen.

Nachdem Du die Code-Vorlage ausgewählt hast, sieht Dein Code im oberen Beispiel folgendermaßen aus:

TRY.
ERP UP
CATCH .

ENDTRY.

Dokumentname

Mit dem Parameter %Document% kannst Du den Namen Deines Programms angeben. Dies ist vor allem in einem Kommentar am Anfang Deines ABAP-Programms nützlich.

Interaktiv

Du kannst Deine eigenen Parameter definieren. Du kannst einen eigenen Parameter definieren, indem du den Namen mit % beginnend und endend umschließt. Ein Beispiel wäre hierfür %Description%. Wenn Du einen eigenen Parameter verwendest, erscheint ein PopUp. In diesem PopUp kannst Du den Wert der Variable eingeben, die anstelle des Parameters im Code verwendet wird.

Im Abschnitt „ABAP Code-Vorlagen aufrufen“ verwende ich einen eigenen Parameter.

Weitere wichtige Parameter

Es gibt weitere wichtige Parameter. Einige sind bereits im Standard enthalten. Andere können selbst erstellt oder an die eigenen Bedürfnisse angepasst werden.

*–

*--------------------------------------------------------------------*

case

CASE |.
	WHEN .
	WHEN .
	WHEN OTHERS.
ENDCASE.

define

DEFINE |.
%SurroundedText%
END-OF-DEFINITION.

do

DO | TIMES.
%SurroundedText%
ENDDO.

header

*& Program name: %Document%
*& Creation date: %DateTime%
*& Transport num.: 
*& Purpose: %Purpose%
*&---------------------------------------------------------------------*
*& Changelog
*& Date                 Name        Purpose
*& %DateTime%	ANDREASG    %Purpose%
*&---------------------------------------------------------------------*

if

IF |.
%SurroundedText%
ENDIF.

ife

IF |.
%SurroundedText%
ELSE.

ENDIF.

loop

LOOP AT |.
%SurroundedText%
ENDLOOP.

region

"$. Region %Region Name%
%SurroundedText%
"$. Endregion %Region Name%

try

TRY.
%SurroundedText%
CATCH |.

ENDTRY.

while

WHILE |.
%SurroundedText%
ENDWHILE.