Mysql
 sql >> Datenbank >  >> RDS >> Mysql

So nutzen Sie die Kommentarfunktion in MySQL optimal

Kommentare werden verwendet, um dem Code Informationen hinzuzufügen. Es wird vom Compiler größtenteils ignoriert, aber menschliche Spezialisten können diese Kommentare lesen, wenn sie Ihren Code anzeigen. Kommentare sind für Entwickler unerlässlich, da sie nur über begrenzte Zeit verfügen, und das Kommentieren ermöglicht es ihnen, sofort wertvolle Informationen zu erhalten oder einige wichtige Details in Bezug auf den Code zu notieren. Durch den Zugriff auf diese Daten können sie die richtigen Entscheidungen treffen und schneller arbeiten.

Wie kann das Kommentieren für mich nützlich sein?

Kommentare sind hilfreich für Sie persönlich und für alle, die diesen Code später lesen oder bearbeiten müssen. Aber wie genau?

  • Kommentare können beim Codieren Platzhalter sein. In diesem Moment könnten Sie etwas annehmen und Sie würden wissen, ob Ihre Annahme in der Zukunft zutrifft.
  • Kommentare können Ihre Gedanken dokumentieren oder Notizen für sich selbst sein, damit Sie Ihre Aktivitäten nicht vergessen, wenn Sie später darauf zurückkommen.
  • Sie können Kommentare zu dem, was Sie getan haben, in Ihren Code einfügen, damit andere Programmierer ihn besser und schneller verstehen (die Zeit der Programmierer ist sehr, sehr teuer).
  • Sie können Kommentare verwenden, um fehlerhafte Teile vorübergehend zu deaktivieren oder zu aktivieren.
  • Das Kommentieren jeder Zeile eines Skripts macht es einfacher zu verfolgen, wo Fehler innerhalb des Programms liegen könnten.
  • Kommentare können erklären, was bestimmte Codezeilen tun oder warum Sie einen bestimmten Ansatz gewählt haben, um Missverständnisse zu vermeiden (z. B. wenn einige Teile des Codes für einen Abschnitt oder einen bestimmten Zweck bestimmt sind, den Sie klar verstehen sollten). ,
  • Sie können einen ganzen Absatz schreiben, der alle Details über den Codeabschnitt erklärt, falls dies für Neulinge oder Leute aus anderen Projekten erforderlich ist. Kommentieren ist oft erforderlich, wenn komplexe SQL-Abfragen mit vielen Klauseln wie INNER JOINs, GROUP BYs usw. geschrieben werden.
  • Mit Kommentaren können Sie sich Notizen zu Ihren Aktivitäten machen. Dies hilft anderen zu verstehen, wie und warum Sie etwas getan haben, damit sie es nach Bedarf pflegen oder ändern können.

Ist SQL eine gute Sprache für Kommentare?

Ja! Kommentare werden am häufigsten in Verbindung mit Sprachen wie SQL und PHP verwendet, wo wir sie mit der Kommentarfunktion * / (z. B. /* Dies ist mein Kommentar */) in eine Textdatei oder ein Skript einfügen können. Sie sind in der Regel auch anderswo genauso einfach zu verwenden.

Wie kommentiere ich in SQL?

Mit der Kommentarfunktion können Sie einen beliebigen Text schreiben, um einen Kommentar in SQL hinzuzufügen. Es wirkt sich nicht auf die endgültige Ausgabe aus, solange es vor oder nach einem bestimmten vorprogrammierten Zeichen steht.

Um Kommentare in SQL hinzuzufügen, können Sie die folgenden Symbole verwenden:/* */ oder # oder — (Doppelstrich).

/* */ funktioniert für jede Situation, in der Sie Ihren Kommentar an dieser Stelle beginnen und beenden möchten, ohne etwas anderes zu verwenden (wie einfache Anführungszeichen).

# wird jeweils für eine Codezeile verwendet

- gilt auch jeweils für eine Codezeile. Vergessen Sie nicht, nach diesem Doppelstrich ein Leerzeichen einzufügen.

In Ihrem Code würde es wie folgt aussehen:

-- this is a comment
# this is also a comment
/*
   multiline
   comment
*/

Hier ist der Unterschied zwischen einzeiligen und mehrzeiligen Kommentaren:

mysql> SELECT 1+1;     # This comment continues to the end of line
mysql> SELECT 1+1;     -- This comment continues to the end of line
mysql> SELECT 1 /* this is an in-line comment */ + 1;
mysql> SELECT 1+
/*
this is a
multiple-line comment
*/
1;

Hier ist ein weiteres Beispiel für einen mehrzeiligen Kommentar:

SELECT contact_id, last_name, first_name
/*
 * Author: TechOnTheNet.com
 * Purpose: To show a comment that spans multiple lines in your SQL
 * statement in MySQL.
 */
FROM contacts;

Kommentieren mit dem #-Symbol

Das grundlegende Hash-Kommentieren Stil kann wie folgt in Text eingefügt werden:

Select * from users ; # this will list users

Kommentieren mit dem Doppelstrich (–)

Dies ist mehr oder weniger dasselbe (vergiss das Leerzeichen nicht). Das Standard-SQL verlangt eigentlich nicht, dass Sie das Leerzeichen dort verwenden, aber MySQL verwendet es, um Probleme mit Befehlen wie SELECT 10–1 zu vermeiden.

Select * from users ; -- this will list users

Kommentieren mit den Symbolen / * und * /

Diese mehrzeilige Kommentierung muss im Gegensatz zu den beiden vorherigen Beispielen nicht am Zeilenende aufhören.

Select * from users ; /* this will list users */

Ausführbare Kommentare

In der Regel werden Kommentare vom anderen Ende ignoriert (weil sie nur für Programmierer sind), aber einige Kommentartypen – ausführbare Kommentare – ermöglichen, dass der Code auf einigen Systemen ausgeführt wird.

In unserem Fall erlauben ausführbare Kommentare die Verwendung von SQL-Codes, die nur in MYSQL ausgeführt werden, nicht in anderen Datenbanken.

Ausführbare Kommentare sollten in Sternchen-Schrägstrichen enthalten sein , wie beim üblichen Code:

/*! MySQL-spezifischer Code */

Diese ausführbaren Kommentare erfordern jedoch eine bestimmte Syntax wie unten:

/*!##### MySQL-spezifischer Code */

Sie brauchen die !##### Teil, um ausführbare Kommentare zu signalisieren. Es stellt die Mindestversion von MYSQL dar, die Kommentare ausführen kann.

Ersetzen Sie anstelle des ersten Hashs die Hauptversion von MYSQL. Anstelle der zweiten werden die letzten 2 durch die jüngere Version und die Versionen des Patches ersetzt.

Nur MySQL 5.1.10 oder neuere Versionen können die folgenden Kommentare ausführen:

CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */

Schlussfolgerung

Kommentare erleichtern das Lesen von Programmen, indem sie weitere Details hinzufügen. Sie können sich Hashes ähnlich vorstellen – sie reduzieren die Zeit, die erforderlich ist, um den Code zu verstehen, oder identifizieren einige Teile davon drastisch, indem sie Snippets bereitstellen, die die Essenz des Textes erfassen. Wenn Sie jemals mit Zero-Knowledge-Proofs gearbeitet oder versucht haben, sich über Google bei Facebook anzumelden, wissen Sie, was wir meinen.

Aus diesem Grund ist es wichtig, Ihren Code zu kommentieren und zu wissen, wie man ihn richtig macht. Die Korrektheit Ihres Codes mit informativen Hinweisen macht das Leben aller beteiligten Spezialisten einfacher.