SQL Comments: So fügen Sie Kommentare in ihren Code ein

SQL Comments werden genutzt, um Anmerkungen direkt innerhalb des Codes zu platzieren. Man unterscheidet zwischen Single-Line-, Multi-Line- und In-Line-Kommentaren.

Was sind SQL Comments?

So wie in vielen anderen Datenbank- und Programmiersprachen erhalten Sie auch in der Structured Query Language die Möglichkeit, innerhalb des Codes Kommentare zu platzieren, die zwar lesbar sind, aber keine Auswirkungen auf die Ausführung haben. Diese haben gleich mehrere mögliche Einsatzzwecke. So können SQL Comments dafür verwendet werden, bestimmte Bereiche innerhalb des Codes näher zu erläutern. Wenn Sie selbst einen späteren Blick auf den Code werfen oder eine andere Person an diesem weiterarbeiten soll, können Sie auf diese Weise Anmerkungen und Ausführungen hinterlegen. Darüber hinaus kann ein Kommentar genutzt werden, die Durchführung eines SQL-Befehls zu unterbinden.

Je nach Lesart lassen sich SQL Comments in zwei oder drei Kategorien unterteilen:

• Single Line Comments: Diese Kommentare starten und enden in derselben Zeile des Codes. Sie beginnen mit --.
• Multi Line Comments: Diese Kommentare umfassen mehrere Zeilen. Sie werden mit /* initiiert und mit */ beendet.
• In Line Comments: Bei diesen Kommentaren handelt es sich um eine Unterart der Multi Line Comments. Sie werden zwischen zwei Anweisungen eingesetzt und ebenfalls durch /* und */ markiert.

Single-Line-Kommentare

Single Line Comments werden durch zwei aufeinanderfolgende Bindestriche angezeigt. Alles, was hinter diese Bindestriche in die jeweilige Zeile geschrieben wird, wird nicht bei der Ausführung berücksichtigt. Das Ende der SQL Comments fällt mit dem Zeilenende zusammen. Ab Beginn der nächsten Zeile wird dann der Code wieder normal ausgeführt. Single-Line-Kommentare müssen somit nicht durch ein Zeichen ausdrücklich beendet werden.

Um die Funktionsweise besser zu verstehen, lohnt sich der Blick auf ein Beispiel. Im folgenden kurzen Code-Ausschnitt stellen wir vor den Befehl SELECT einen Kommentar, der seinen Einsatzzweck näher beschreibt.

-- Alle Einträge aus der Tabelle Mitarbeitende aufrufen
SELECT *
FROM Mitarbeitende;

Berücksichtigt wird somit nur der Code ab SELECT.

Es ist auch möglich, einen Single-Line-Kommentar nach einer Anweisung einzusetzen. Anweisung und Kommentar können in derselben Zeile stehen, sofern der Kommentar auf die Anweisung folgt. Andersherum ist dies nicht möglich.

SELECT * -- wähle alle Einträge aus
FROM Mitarbeitende; -- berücksichtige die Tabelle namens Mitarbeitende

Multi-Line-Kommentare

Ein wenig anders funktionieren SQL Comments, die sich über mehrere Zeilen erstrecken. Diese müssen nämlich unbedingt neben einem Start- auch einen Endpunkt haben. Der gesamte Text, der zwischen diesen beiden Punkten steht, wird bei der Ausführung des Codes ignoriert. Für unser Beispiel von oben könnte das folgendermaßen aussehen:

/* Wähle sämtliche Felder
in allen Zeilen
der gesamten Tabelle namens Mitarbeitende aus: */
SELECT *
FROM Mitarbeitende;

Es ist auch möglich, diese SQL Comments zu nutzen, um die Ausführung einer bestimmten Anweisung zu unterbinden. Das kann nützlich sein, wenn Sie diese bereits eingesetzt haben, aber vorrübergehend ignorieren möchten. Dies ist ein dazu passendes Beispiel:

/*SELECT* FROM Abrechnungen;
SELECT * FROM Wareneingänge;
SELECT * FROM Retouren;
SELECT *FROM Kundenliste;*/
SELECT * FROM Mitarbeitende;

Obwohl wir hier gleich fünf Anweisungen hinterlegt haben, wird das System lediglich die Tabelle für Mitarbeitende aufrufen. Abrechnungen, Wareneingänge, Retouren und die Kundenliste stehen innerhalb des Kommentars und werden damit ignoriert.

In-Line-Kommentare

In Line Comments sind eine Unterart der regulären Multi-Line-Kommentare. Durch den klaren Anfangs- und Endpunkt können sie auch zwischen den Anweisungen platziert werden. Wichtig ist dabei, dass der Lesefluss nicht zu stark beeinträchtigt werden sollte. Gerade wenn Sie allerdings einen bestimmten Teil einer Zeile näher erläutern möchten, können In Line Comments eine gute Wahl sein. Im folgenden einfachen Beispiel sehen Sie, wie ein solcher Kommentar funktioniert:

SELECT *
FROM /*Fügen Sie hier den Namen der Tabelle ein*/ Mitarbeitende;

Das System wird ungehindert die gesamte Tabelle namens „Mitarbeitende“ und all ihre Spalten und Felder anzeigen. Der Kommentar ist nur für Sie oder einen anderen Nutzer bzw. eine andere Nutzerin des Codes sichtbar.