SQL Comments: So fügen Sie Kom­men­ta­re in ihren Code ein

SQL Comments werden genutzt, um An­mer­kun­gen direkt innerhalb des Codes zu plat­zie­ren. Man un­ter­schei­det zwischen Single-Line-, Multi-Line- und In-Line-Kom­men­ta­ren.

Was sind SQL Comments?

So wie in vielen anderen Datenbank- und Pro­gram­mier­spra­chen erhalten Sie auch in der Struc­tu­red Query Language die Mög­lich­keit, innerhalb des Codes Kom­men­ta­re zu plat­zie­ren, die zwar lesbar sind, aber keine Aus­wir­kun­gen auf die Aus­füh­rung haben. Diese haben gleich mehrere mögliche Ein­satz­zwe­cke. 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 wei­ter­ar­bei­ten soll, können Sie auf diese Weise An­mer­kun­gen und Aus­füh­run­gen hin­ter­le­gen. Darüber hinaus kann ein Kommentar genutzt werden, die Durch­füh­rung eines SQL-Befehls zu un­ter­bin­den.

Je nach Lesart lassen sich SQL Comments in zwei oder drei Ka­te­go­rien un­ter­tei­len:

• Single Line Comments: Diese Kom­men­ta­re starten und enden in derselben Zeile des Codes. Sie beginnen mit --.
• Multi Line Comments: Diese Kom­men­ta­re umfassen mehrere Zeilen. Sie werden mit /* initiiert und mit */ beendet.
• In Line Comments: Bei diesen Kom­men­ta­ren handelt es sich um eine Unterart der Multi Line Comments. Sie werden zwischen zwei An­wei­sun­gen ein­ge­setzt und ebenfalls durch /* und */ markiert.

Single-Line-Kom­men­ta­re

Single Line Comments werden durch zwei auf­ein­an­der­fol­gen­de Bin­de­stri­che angezeigt. Alles, was hinter diese Bin­de­stri­che in die jeweilige Zeile ge­schrie­ben wird, wird nicht bei der Aus­füh­rung be­rück­sich­tigt. Das Ende der SQL Comments fällt mit dem Zei­len­en­de zusammen. Ab Beginn der nächsten Zeile wird dann der Code wieder normal aus­ge­führt. Single-Line-Kom­men­ta­re müssen somit nicht durch ein Zeichen aus­drück­lich beendet werden.

Um die Funk­ti­ons­wei­se besser zu verstehen, lohnt sich der Blick auf ein Beispiel. Im folgenden kurzen Code-Aus­schnitt stellen wir vor den Befehl SELECT einen Kommentar, der seinen Ein­satz­zweck näher be­schreibt.

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

Be­rück­sich­tigt wird somit nur der Code ab SELECT.

Es ist auch möglich, einen Single-Line-Kommentar nach einer Anweisung ein­zu­set­zen. Anweisung und Kommentar können in derselben Zeile stehen, sofern der Kommentar auf die Anweisung folgt. An­ders­her­um ist dies nicht möglich.

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

Multi-Line-Kom­men­ta­re

Ein wenig anders funk­tio­nie­ren SQL Comments, die sich über mehrere Zeilen er­stre­cken. 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 Aus­füh­rung des Codes ignoriert. Für unser Beispiel von oben könnte das fol­gen­der­ma­ß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 Aus­füh­rung einer be­stimm­ten Anweisung zu un­ter­bin­den. Das kann nützlich sein, wenn Sie diese bereits ein­ge­setzt haben, aber vor­rü­ber­ge­hend igno­rie­ren 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 An­wei­sun­gen hin­ter­legt haben, wird das System lediglich die Tabelle für Mit­ar­bei­ten­de aufrufen. Ab­rech­nun­gen, Wa­ren­ein­gän­ge, Retouren und die Kun­den­lis­te stehen innerhalb des Kom­men­tars und werden damit ignoriert.

In-Line-Kom­men­ta­re

In Line Comments sind eine Unterart der regulären Multi-Line-Kom­men­ta­re. Durch den klaren Anfangs- und Endpunkt können sie auch zwischen den An­wei­sun­gen platziert werden. Wichtig ist dabei, dass der Lesefluss nicht zu stark be­ein­träch­tigt werden sollte. Gerade wenn Sie al­ler­dings einen be­stimm­ten 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 funk­tio­niert:

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

Das System wird un­ge­hin­dert die gesamte Tabelle namens „Mit­ar­bei­ten­de“ 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.