Commentaires MySQL

1. Commentaires MySQL sur une seule ligne
2. Commentaire multiligne MySQL
3. Commentaires exécutables MySQL
4. Conclusion

Dans cet article, nous présenterons les commentaires MySQL. Nous apprendrons également où et quel type de commentaire doit être utilisé.

Les commentaires sont écrits pour décrire le code, le rendre facile à comprendre. Nous utilisons également des commentaires pour ignorer une certaine partie du code lors de l’analyse des requêtes SQL (ne laissez pas ce morceau de code être exécuté).

Cela aide également les autres programmeurs à comprendre ce qui se passe dans le code. Nous verrons comment utiliser les commentaires sur une seule ligne et sur plusieurs lignes dans MySQL. Nous verrons également les commentaires exécutables et leurs utilisations.

Il existe trois manières différentes d’écrire des commentaires MySQL. Nous pouvons utiliser les symboles #, -, ou /* et */ pour commenter.

Commentaires MySQL sur une seule ligne

Nous pouvons utiliser les commentaires MySQL sur une seule ligne de deux manières, soit en utilisant # ou -.

Créons une table nommée tb_teachers pour pratiquer les commentaires MySQL. Nous utilisons # pour écrire un commentaire d’une seule ligne dans la requête MySQL donnée ci-dessous.

Ce commentaire est utilisé à la fin de la requête SQL et doit être suivi d’un saut de ligne. Si vous n’utilisez pas de saut de ligne après le commentaire, tout ce qui se trouve sur la même ligne sera commenté jusqu’à ce qu’il rencontre un saut de ligne. Il n’est pas obligatoire de mettre un espace blanc après #. Mais c’est une bonne approche d’avoir un espace blanc après # pour augmenter la lisibilité.

Exemple de code MySQL utilisant # :

# Following SQL query will create a table named 'tb_teachers'
CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
 TEACHER_ID	INTEGER NOT NULL,
 FIRST_NAME	VARCHAR(30) NOT NULL,
 LAST_NAME	VARCHAR(30) NOT NULL,
 GENDER	VARCHAR(30) NOT NULL,
 CITY	VARCHAR(64) NOT NULL,
 EMAIL	VARCHAR(64) NOT NULL,
 JOINING_YEAR INTEGER NOT NULL,
 PRIMARY KEY	(TEACHER_ID)
);

Voir l’exemple de code suivant où nous ne mettons pas de saut de ligne après avoir utilisé un commentaire sur une seule ligne. Vous pouvez voir que la commande CREATE est également partiellement commentée.

# Following SQL query will create a table named 'tb_teachers' CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
 TEACHER_ID	INTEGER NOT NULL,
 FIRST_NAME	VARCHAR(30) NOT NULL,
 LAST_NAME	VARCHAR(30) NOT NULL,
 GENDER	VARCHAR(30) NOT NULL,
 CITY	VARCHAR(64) NOT NULL,
 EMAIL	VARCHAR(64) NOT NULL,
 JOINING_YEAR INTEGER NOT NULL,
 PRIMARY KEY	(TEACHER_ID)
);

Nous pouvons également utiliser ce type de commentaire dans la requête SQL. Voir le morceau de code suivant ; vous pouvez observer que nous pouvons commenter dans la requête SQL en utilisant #.

# Following SQL query will create a table named 'tb_teachers' 
CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
 TEACHER_ID	INTEGER NOT NULL, # teacher's id
 FIRST_NAME	VARCHAR(30) NOT NULL, # teacher's first name
 LAST_NAME	VARCHAR(30) NOT NULL, # teacher's last name
 GENDER	VARCHAR(30) NOT NULL, # teacher's gender
 CITY	VARCHAR(64) NOT NULL, # teacher's home town
 EMAIL	VARCHAR(64) NOT NULL, # teacher's email
 JOINING_YEAR INTEGER NOT NULL, # teacher's appointment year
 PRIMARY KEY (TEACHER_ID) # primay key of the teacher's table
);

Explorons l’autre manière de commenter une seule ligne en utilisant le symbole -. Le code SQL suivant montre que nous pouvons utiliser le symbole double - (tiret) pour commenter même dans la requête SQL.

C’est la même chose que nous commentons en utilisant le symbole # avec une seule différence. Nous devons mettre au moins un espace blanc après le deuxième tiret ; sinon, il n’agira pas comme un commentaire.

-- Following SQL query will create a table named 'tb_students' 
CREATE TABLE `practice_mysql_comments`.`tb_students` (
 STUDENT_ID	INTEGER NOT NULL, -- student's id
 FIRST_NAME	VARCHAR(30) NOT NULL, -- student's first name
 LAST_NAME	VARCHAR(30) NOT NULL, -- student;s last name
 GENDER	VARCHAR(30) NOT NULL, -- student's gender
 CITY	VARCHAR(64) NOT NULL, -- student's home town
 EMAIL	VARCHAR(64) NOT NULL, -- student's email
 REGISTRATION_YEAR INTEGER NOT NULL, -- student's registration year
 PRIMARY KEY (STUDENT_ID) -- primay key of the student's table
);

Commentaire multiligne MySQL

Si nous devons expliquer la requête SQL en détail pour rendre le code facile à comprendre, nous utilisons des commentaires multilignes. Tout ce qui se trouve entre /* */ sera ignoré. Que vous mettiez ou non un saut de ligne à la fin de ce type de commentaire, peu importe, mais c’est bien d’avoir un saut de ligne pour écrire un code propre et organisé.

/* 
Following SQL query will create a table named 'tb_students'
having the basic information about the students. This information includes
full name, gender, city, email and registration year.
*/
CREATE TABLE `practice_mysql_comments`.`tb_students` (
 STUDENT_ID	INTEGER NOT NULL, 
 FIRST_NAME	VARCHAR(30) NOT NULL, 
 LAST_NAME	VARCHAR(30) NOT NULL, 
 GENDER	VARCHAR(30) NOT NULL, 
 CITY	VARCHAR(64) NOT NULL, 
 EMAIL	VARCHAR(64) NOT NULL,
 REGISTRATION_YEAR INTEGER NOT NULL, 
 PRIMARY KEY (STUDENT_ID) 
);

Bien que nous puissions traiter les commentaires sur plusieurs lignes comme une seule ligne, pourquoi augmenter l’effort lorsque nous avons des commentaires sur une seule ligne. Il est bon d’utiliser des commentaires multi-lignes lorsque vous ne souhaitez pas exécuter plus d’une ligne. Voir l’exemple suivant.

/* 
Following SQL query will create a table named 'tb_students'
having the basic information about the students. This information includes
full name, gender, city, email and registration year.
*/
CREATE TABLE `practice_mysql_comments`.`tb_students` (
 STUDENT_ID	INTEGER NOT NULL, 
 FIRST_NAME	VARCHAR(30) NOT NULL, 
 LAST_NAME	VARCHAR(30) NOT NULL, 
 GENDER	VARCHAR(30) NOT NULL, 
 CITY	VARCHAR(64) NOT NULL, 
 /* EMAIL	VARCHAR(64) NOT NULL,
 REGISTRATION_YEAR INTEGER NOT NULL, */
 PRIMARY KEY (STUDENT_ID) 
);

Commentaires exécutables MySQL

MySQL prend également en charge les commentaires exécutables. Ce type de commentaire vous donne la portabilité entre différentes bases de données. Le code écrit dans ces commentaires ne sera exécuté que dans MySQL. Si vous spécifiez version après le ! caractère, cela ne fonctionnera que sur cette version MySQL particulière ou au-dessus.

Exemple de code de commentaires exécutables :

SELECT 3 /*! *2 */ AS MULTIPLICATION;

Conclusion

Nous avons conclu que les commentaires MySQL jouent un rôle vital lors de la programmation. Peu importe le type de programmation dont il s’agit. L’utilisation de commentaires multilignes est un bon choix si vous devez ignorer plus d’une ligne ; sinon, un commentaire d’une seule ligne convient. Vous pouvez utiliser les commentaires de l’exécutable MySQL si vous souhaitez qu’un certain morceau de code soit exécuté uniquement sur le serveur MySQL.