Résumé: dans ce tutoriel, vous apprendrez comment utiliser les commentaires MySQL pour documenter une instruction SQL ou un bloc de code dans MySQL.
Les commentaires peuvent être utilisés pour documenter l’objectif de une instruction SQL ou la logique d’un bloc de code dans une procédure stockée. Lors de l’analyse du code SQL, MySQL ignore la partie commentaires. Il n’exécute que la partie SQL à l’exception du commentaire exécutable, dont nous parlerons dans la section suivante.
MySQL prend en charge trois styles de commentaire:
- À partir d’un
"-- "
à la fin de la ligne. Le style de commentaire à double tiret nécessite au moins un espace ou un caractère de contrôle (espace, tabulation, nouvelle ligne, etc.) après le deuxième tiret.SELECT * FROM users; -- This is a comment
Notez que SQL standard ne nécessite pas de espace après le deuxième tiret. MySQL utilise un espace pour éviter les problèmes avec certaines constructions SQL telles que:
SELECT 10--1;
L’instruction renvoie 11. Si MySQL n’utilisait pas l’espace, il renvoyez plutôt 10.
- D’un
"#"
à la fin de la ligne.SELECT lastName, firstNameFROM employeesWHERE reportsTo = 1002; # get subordinates of Diane
- Les commentaires de style C
/**/
peuvent s’étendre sur plusieurs lignes. Vous utilisez ce style de commentaire pour documenter un bloc de code SQL./* Get sales rep employees that reports to Anthony*/SELECT lastName, firstNameFROM employeesWHERE reportsTo = 1143 AND jobTitle = "Sales Rep";
Notez que MySQL ne prend pas en charge les commentaires imbriqués.
Commentaires exécutables
MySQL fournit des commentaires exécutables pour prendre en charge la portabilité entre différentes bases de données. Ces commentaires vous permettent d’incorporer du code SQL qui ne s’exécutera que dans MySQL mais pas dans d’autres bases de données.
Ce qui suit illustre la syntaxe des commentaires exécutables:
Code language: SQL (Structured Query Language) (sql)
Par exemple, l’instruction suivante utilise un commentaire exécutable:
Code language: SQL (Structured Query Language) (sql)
L’instruction renvoie 2 au lieu de 1. Cependant, elle renverra 1 si vous exécutez dans d’autres systèmes de base de données.
Si vous souhaitez exécuter un commentaire à partir d’une version spécifique de MySQL, vous utilisez la syntaxe suivante:
Code language: SQL (Structured Query Language) (sql)