Direkt zum Inhalt

Wie man Kommentare in SQL erstellt

Überprüfe drei Methoden, um Kommentare in SQL hinzuzufügen: einzeilige Kommentare, mehrzeilige Kommentare und Inline-Kommentare unter Verwendung der folgenden Syntax: --, /*, und */.
Aktualisierte 15. Jan. 2025  · 5 Min. Lesezeit

SQL, die Abkürzung für Structured Query Language, ist eine leistungsstarke Sprache zur Verwaltung und Bearbeitung relationaler Datenbanken. Auch wenn SQL-Abfragen auf den ersten Blick selbsterklärend sind, kann das Hinzufügen von Kommentaren in SQL-Anweisungen die Lesbarkeit und Wartbarkeit deines Codes verbessern.

In diesem Lernprogramm zeigen wir dir, wie du Kommentare in SQL einfügst, um deinen Code einfacher und lesbarer zu machen.

Die schnelle Antwort: Wie man Kommentare in SQL erstellt

Es gibt drei Möglichkeiten, Kommentare zu deinen SQL-Abfragen hinzuzufügen:

  1. Einzeilige Kommentare: Einzeilige Kommentare beginnen mit -- doppelten Bindestrichen.

  2. Inline-Kommentare: Inline-Kommentare beginnen mit -- nach der SQL-Anweisung in der gleichen Zeile.
  3. Mehrzeilige Kommentare oder Blockkommentare: Mehrzeilige Kommentare beginnen mit /* und enden mit */.

 -- Single line comment
SELECT * 
FROM TABLE

SELECT * 
FROM TABLE -- Inline comment

/* Multiline
comment */ 
SELECT * 
FROM TABLE  

Warum sind SQL-Kommentare wichtig?

Hier sind drei wichtige Gründe, warum SQL-Kommentare wichtig sind:

  • Klärung des Zwecks des Kodex: Kommentare erklären den Zweck und die Logik des Codes und machen ihn für andere und dich selbst leichter verständlich, wenn du deinen Code später überprüfst.
  • Verbesserung der Teamarbeit: Kommentare erleichtern die Teamarbeit, indem sie den Code für andere Entwickler dokumentieren und ihnen helfen, deine Arbeit zu verstehen.
  • Hilfe beim Debuggen und Optimieren: Kommentare vereinfachen das Debuggen und Optimieren des Codes im Laufe der Zeit und machen es einfacher, Probleme zu erkennen und zu beheben.

Arten von SQL-Kommentaren

Je nach deinen Bedürfnissen und Vorlieben gibt es drei Möglichkeiten, Kommentare in SQL-Skripte einzufügen.

Einzeilige Kommentare

Wenn dein Kommentar gut in eine einzige Zeile passt, verwende doppelte Bindestriche. Normalerweise platzierst du solche Kommentare über dem entsprechenden Codeblock, um den Kontext zu verdeutlichen.

--select the department name from the department table
SELECT dept_name
FROM employees.departments;

Inline-Kommentare

Wie wir im folgenden Beispiel sehen, verwenden einzeilige und Inline-Kommentare in SQL dieselbe Syntax und sind im Wesentlichen identisch; der Unterschied liegt darin, wo und wie sie platziert werden. Inline-Kommentare werden normalerweise verwendet, um einen bestimmten Teil der Abfrage zu erklären.

SELECT DISTINCT title -- It excludes duplicate titles using the DISTINCT keyword.
FROM employees.titles
ORDER BY title ASC -- The results are sorted alphabetically by the 'title' column.
LIMIT 10;

Mehrzeilige Kommentare oder Blockkommentare

Du kannst mehrzeilige Kommentare in SQL verwenden, um längere Kommentare über mehrere Zeilen hinweg einzufügen. Um mehrzeilige Kommentare hinzuzufügen, schließe deinen Text zwischen /* und */ ein. Der SQL-Interpreter ignoriert jeden Text, der zwischen /* und */ steht.

/*
This query retrieves the employee number, first name, last name, and gender
from the 'employees' table in the 'employees' database.
It filters the results only to include male employees, limiting to 4 rows.
*/
SELECT emp_no, first_name, last_name, gender
FROM employees.employees
WHERE employees.employees.gender = 'M'
LIMIT 4;

Best Practices für das Schreiben von SQL-Kommentaren

Um sicherzustellen, dass deine Kommentare in deiner Codebasis sowohl prägnant als auch informativ sind, ist es wichtig, dass du dich an die Best Practices hältst. Im Folgenden findest du einige der Richtlinien. 

Klarheit und Lesbarkeit

Vermeide es, in deinen Kommentaren übermäßig komplexe oder technische Begriffe zu verwenden. So wird sichergestellt, dass sie klar und prägnant sind, so dass sie jeder verstehen kann, auch diejenigen, die mit der Codebasis nicht vertraut sind.

Relevante Informationen hinzufügen

Vergewissere dich, dass die Informationen, die du bereitstellst, korrekt sind und sich direkt auf den Code beziehen, den sie beschreiben. Es sollte die Argumentation hinter der komplexen Logik erklären. Vermeide es, sensible Informationen wie Passwörter und API-Schlüssel in Kommentaren anzugeben.

Regelmäßig aktualisieren

Veraltete Kommentare können in die Irre führen und zu technischen Schulden beitragen. Deshalb solltest du deine Kommentare überprüfen und aktualisieren, wenn du den Code aktualisierst, um die neuesten Änderungen zu berücksichtigen.

Redundanz vermeiden

Kommentare sollten nicht einfach wiederholen, was der Code tut. Stattdessen sollten Kommentare das "Warum" hinter dem Code erklären - den Zweck oder den Zusammenhang, der aus dem Code selbst nicht sofort ersichtlich ist.

Häufige Fehler bei SQL-Kommentaren

Die Kommentierung deines SQL-Codes ist sehr wichtig, damit du alles übersichtlich und verständlich hältst, vor allem, wenn du deinen Code Monate später noch einmal überarbeiten musst. Aber selbst mit den besten Absichten kann man leicht in Fallen tappen, die deine Kommentare eher verwirrend als hilfreich machen. Hier sind einige häufige Fehler, die du beim Schreiben von SQL-Kommentaren vermeiden solltest:

Zweideutige oder irreführende Kommentare

Schreibe prägnante und eindeutige Kommentare, die dem Leser einen Mehrwert bieten. Unklare oder ungenaue Kommentare sind schlimmer als keine Kommentare.

Code überkommentieren

Kommentare sind zwar hilfreich, aber zu viele Kommentare können das Lesen und Warten des Codes erschweren. Versuche, dich darauf zu konzentrieren, den übergeordneten Zweck und alle nicht offensichtlichen Aspekte des Codes zu erklären.

Werfen wir einen Blick auf ein schlechtes Beispiel:

Schlechtes Beispiel für einen Kommentar in SQL

Kommentar in einer SQL-Abfrage. Bild vom Autor.

Da unsere Variablen explizite Namen hatten, haben die Kommentare den Code nur wiedergegeben, ohne zusätzlichen Kontext zu liefern oder den Zweck zu erklären.

Inkonsistenter Kommentarstil

Uneinheitliche Stile lenken ab und erschweren das Lesen des Codes. Um dies zu vermeiden, solltest du in deiner gesamten Codebasis einen einheitlichen Stil für die Kommentierung verwenden. 

  • Kapitalisierung: Wenn du eine einheitliche Großschreibung beibehältst, ist dein Code leichter zu lesen und zu verstehen.
  • Zeichensetzung: Alle Kommentare mit einem Punkt zu beenden, kann eine gute Praxis sein, ist aber keine strikte Regel. Das wichtigste Ziel ist Beständigkeit.
  • Formatierung: Wenn du klare Richtlinien für die Verwendung von Blockkommentaren und Inline-Kommentaren festlegst, sorgst du für Konsistenz.

Fehlender Kontext

Das folgende Beispiel enthält eine ausführliche Beschreibung des Zwecks unseres SQL-Codes: "Rufe Kundenbestellungen für die Berichterstattung ab." Er ist zwar genau, aber es fehlt der Kontext, der dem Leser hilft, den Code vollständig zu verstehen.

/*
* Retrieve employees' data for reporting
*/
SELECT e.first_name, e.last_name, s.salary
FROM employees.employees e
JOIN employees.salaries s ON e.emp_no = s.emp_no
WHERE s.salary > 150000
ORDER BY s.salary DESC;

Um unseren Kommentar zu verbessern, können wir ihn aktualisieren und mehr Details hinzufügen.

/* Retrieve employees' names and salaries where salary is above $150,000
as part of the monthly HR reporting process.
*/
SELECT e.first_name, e.last_name, s.salary
FROM employees.employees e
JOIN employees.salaries s ON e.emp_no = s.emp_no
WHERE s.salary > 150000
ORDER BY s.salary DESC;

Fortgeschrittene Verwendungen von SQL-Kommentaren

SQL-Kommentare verbessern nicht nur die Lesbarkeit, sondern helfen auch bei der Codierung. In diesem Abschnitt gehen wir auf die erweiterten Einsatzmöglichkeiten von SQL-Kommentaren ein, z. B. das Einbetten von Metadaten, das Debuggen von SQL-Code und das vorübergehende Deaktivieren von Code. Diese Techniken tragen dazu bei, die Codierung zu rationalisieren, sodass du deine SQL-Skripte leichter verwalten und Fehler effektiv beheben kannst.

Metadaten einbetten

Du kannst Kommentare verwenden, um Metadaten über den SQL-Code einzubetten, z. B. den Namen des Autors und das Datum der Erstellung oder Änderung.

/*
Author: DataCamp
Date: 2024-05-28
Purpose: Retrieve employees' credentials for their record
*/
SELECT emp_no, first_name, last_name
FROM employees.employees

SQL-Code debuggen

Du kannst Teile deines SQL-Codes auskommentieren, um bestimmte Teile zu isolieren und zu testen. So kannst du herausfinden, wo ein Problem auftreten könnte.

/*SELECT * FROM Customers;
SELECT * FROM Products;
SELECT * FROM Orders;*/
SELECT * FROM Categories;

Code vorübergehend deaktivieren

Du kannst SQL-Code vorübergehend deaktivieren, indem du einzeilige Kommentare (--) oder mehrzeilige Kommentare in SQL (/* ... */) verwendest. Auf diese Weise kannst du den Code in der Abfrage behalten, ohne ihn auszuführen, was nützlich sein kann, um nur bestimmte Teile deines SQL-Codes zu testen.

SELECT column1, column2
FROM table1
WHERE condition1
/*
AND condition2
OR condition3
*/

Mythen und Missverständnisse

Trotz ihrer weiten Verbreitung gibt es einige hartnäckige Mythen und Missverständnisse über SQL-Kommentare.

Mythos Nr. Myth Realität
1 SQL-Kommentare verlangsamen die Ausführung. Die SQL-Engine ignoriert Kommentare, sodass sie keinen Einfluss auf die Leistung haben.
2 SQL-Kommentare machen den Code schwieriger zu lesen und zu verstehen. Gut geschriebene Kommentare haben den gegenteiligen Effekt: Sie können den Code leichter lesbar machen.
3 SQL-Kommentare sind nur für Anfänger nützlich. Auch erfahrene Entwickler können von gut geschriebenen Kommentaren profitieren, vor allem wenn sie an komplexen Abfragen arbeiten oder den Code nach langer Zeit wieder ansehen.

Schlussgedanken

Auch wenn es für die SQL-Entwicklung unbedeutend erscheinen mag, können Kommentare den Code verbessern und ihn leichter verständlich machen. Durch das Verfassen klarer und gut strukturierter Kommentare können Entwickler sicherstellen, dass ihr SQL-Code auch noch Jahre nach seiner Erstellung zugänglich ist.

Wenn du gerade erst mit SQL anfängst, kann dir ein Kurs wie SQL Fundamentals dabei helfen, die Bedeutung des Kommentierens frühzeitig zu verstehen. Wenn du Fortschritte machst, bestätigt die SQL Associate Zertifizierung deine Fähigkeiten und zeigt, dass du klaren, gut dokumentierten Code schreiben kannst. Um deine Fähigkeiten weiter zu verbessern, taucht Intermediate SQL tiefer in komplexere Abfragen ein, bei denen detaillierte Kommentare z.B. zur Fehlersuche verwendet werden können.


Laiba Siddiqui's photo
Author
Laiba Siddiqui
LinkedIn
Twitter

Ich bin ein Inhaltsstratege, der es liebt, komplexe Themen zu vereinfachen. Ich habe Unternehmen wie Splunk, Hackernoon und Tiiny Host geholfen, ansprechende und informative Inhalte für ihr Publikum zu erstellen.

Häufig gestellte Fragen

Wie kann ich sicherstellen, dass meine SQL-Kommentare für neue Teammitglieder verständlich sind?

Verwende klare und beschreibende Kommentare, die den Zweck und die Funktionalität des Codes effektiv erklären.

Wie helfen SQL-Kommentare bei der Fehlersuche?

SQL-Kommentare können bei der Fehlersuche helfen, indem sie zusätzlichen Code-Kontext liefern. Das hilft dabei, Fehler effizienter zu erkennen und zu beheben.

Sind SQL-Kommentare für alle SQL-Abfragen notwendig?

Nein, SQL-Kommentare sind nicht für alle SQL-Abfragen notwendig. Sie sind jedoch sehr empfehlenswert für komplexe Abfragen und für Abfragen, die ohne zusätzlichen Kontext schwer zu verstehen sind.

Gibt es bestimmte Tools oder Schnittstellen, die zusätzliche Einschränkungen für Kommentare haben?

Einige Tools, wie z.B. SQLPlus, können zusätzliche Einschränkungen für Kommentare haben. SQLPlus lässt zum Beispiel keine Leerzeile innerhalb eines mehrzeiligen Kommentars zu.

Stimmt es, dass nur Anfänger Kommentare in SQL schreiben müssen?

Nein, auch erfahrene Entwicklerinnen und Entwickler profitieren von gut geschriebenen Kommentaren, vor allem, wenn sie an komplexen Abfragen arbeiten oder den Code nach langer Zeit wieder ansehen.

Themen

SQL lernen mit DataCamp

Zertifizierung verfügbar

Kurs

Einführung in SQL

2 hr
973.8K
Lerne in nur zwei Stunden, wie man relationale Datenbanken mit SQL erstellt und abfragt.
Siehe DetailsRight Arrow
Kurs starten

Lernpfad

SQL-Grundlagen

26Stunden hr
Beherrsche die SQL-Grundlagen, die du für dein Geschäft brauchst, lerne, wie du SQL-Abfragen schreibst, und beginne, deine Daten mit dieser leistungsstarken Sprache zu analysieren.
Mehr anzeigenRight Arrow