SQL Comments : insérer des commentaires dans votre code SQL

Les commentaires SQL (SQL Comments) sont utilisés pour placer des remarques directement à l’intérieur du code. On distingue les commentaires Single Line, Multi-Line et Inline.

SQL Comments : de quoi s’agit-il ?

Comme dans de nombreux autres langages de base de données et langages de programmation, le Structured Query Language vous permet de placer des commentaires dans le code, qui sont certes lisibles, mais n’ont aucun effet sur l’exécution. Ceux-ci ont plusieurs utilisations possibles. Ainsi, les commentaires SQL peuvent être utilisés pour expliquer plus en détail certaines parties du code. Si vous souhaitez jeter un coup d’œil au code plus tard ou si vous voulez que quelqu’un d’autre continue à travailler sur le code, vous pouvez ajouter des remarques et des explications de cette manière. De plus, un commentaire peut être utilisé pour empêcher l’exécution d’une commande SQL.

Selon l’interprétation, les commentaires SQL peuvent être divisés en deux ou trois catégories :

  • Single Line Comments : ces commentaires commencent et se terminent sur la même ligne de code. Ils commencent par --.
  • *Multi-Line Comments *: ces commentaires couvrent plusieurs lignes. Ils sont initiés par /* et se terminent par */.
  • *Inline Comments *: ces commentaires sont une sous-catégorie des Multi-Line Comments. Ils sont insérés entre deux instructions et sont également marqués par /* et */.
Serveurs virtuels (VPS)
Faites le choix de la performance
  • Virtualisation complète avec accès root
  • Trafic illimité et jusqu'à 1 Gbit/s de bande passante
  • Stockage SSD NVMe rapide et édition Plesk Web Host

Single Line Comments

Les commentaires sur une seule ligne sont indiqués par deux tirets consécutifs. Tout ce qui est écrit après ces tirets dans la ligne correspondante n’est pas pris en compte lors de l’exécution. La fin des SQL Comments coïncide avec la fin de la ligne. Le code est alors à nouveau exécuté normalement à partir du début de la ligne suivante. Ces commentaires ne doivent donc pas être terminés explicitement par un caractère.

Pour mieux comprendre le fonctionnement des commentaires, prenons un exemple concret. Dans le court extrait de code suivant, nous plaçons devant la commande SELECT un commentaire qui décrit plus en détail son utilisation.

-- Appeler toutes les entrées de la table Employés
SELECT *
FROM Employés;
sql

Seul le code à partir de SELECT est pris en compte.

Il est également possible d’insérer un tel commentaire après une instruction. L’instruction et le commentaire peuvent être placés sur la même ligne, à condition que ce dernier suive l’instruction. L’inverse n’est en revanche pas possible.

SELECT * -- Sélectionne tous les enregistrements
FROM Employés; -- prend en compte la table appelée Employés
sql

Multi-Line Comments

Les commentaires SQL multilignes sont structurés différemment. Ils nécessitent explicitement un début et une fin. Tout texte situé entre ces deux marqueurs est exclu de l’exécution du code. Voici comment cela pourrait être appliqué à l’exemple mentionné précédemment :

/* Sélectionner tous les champs
dans toutes les lignes
de toute la table nommée Employés : */
SELECT *
FROM Employés;
sql

Il est également possible d’utiliser ces SQL Comments pour empêcher l’exécution d’une certaine instruction. Cela peut être utile si vous l’avez déjà utilisée, mais que vous souhaitez l’ignorer temporairement. Voici un exemple :

/ *SELECT*  FROM Factures;
SELECT * FROM Marchandises;
SELECT * FROM Retours;
SELECT  *FROM Clients;* /
SELECT * FROM Employés;
sql

Bien que nous ayons défini ici cinq instructions, le système n’appellera que la table des employés. Les factures, les marchandises, les retours et la liste des clients se trouvent dans le commentaire et sont donc ignorés.

Inline Comments

Les commentaires en ligne sont une variante des commentaires multilignes habituels. Ils se distinguent par des délimiteurs de début et de fin clairement définis, ce qui permet de les insérer même au milieu des instructions. Il est crucial de veiller à ne pas perturber la lisibilité du code. Cependant, pour fournir des explications détaillées sur un segment précis d’une ligne, ces commentaires sont particulièrement appropriés. Voici un exemple illustrant comment utiliser un tel commentaire :

SELECT *
FROM / *Insérez ici le nom de la table* / Employés;
sql

Le système affichera librement toute la table nommée « Employés » et toutes ses colonnes et champs. Le commentaire ne sera visible que par vous ou par un autre utilisateur du code.

Conseil

Qu’il s’agisse de MSSQL, MySQL ou MariaDB, avec le serveur d’hébergement SQL de IONOS, vous n’avez pas seulement le choix entre les meilleures options de serveur, mais vous profitez également de performances exceptionnelles, de mécanismes de sécurité solides et de conseils personnalisés !

Cet article vous a-t-il été utile ?