SQL Comments : insérer des com­men­taires dans votre code SQL

Les com­men­taires SQL (SQL Comments) sont utilisés pour placer des remarques di­rec­te­ment à l’intérieur du code. On distingue les com­men­taires 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 pro­gram­ma­tion, le Struc­tu­red Query Language vous permet de placer des com­men­taires dans le code, qui sont certes lisibles, mais n’ont aucun effet sur l’exécution. Ceux-ci ont plusieurs uti­li­sa­tions possibles. Ainsi, les com­men­taires 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 à tra­vail­ler sur le code, vous pouvez ajouter des remarques et des ex­pli­ca­tions de cette manière. De plus, un com­men­taire peut être utilisé pour empêcher l’exécution d’une commande SQL.

Selon l’in­ter­pré­ta­tion, les com­men­taires SQL peuvent être divisés en deux ou trois ca­té­go­ries :

• Single Line Comments : ces com­men­taires com­men­cent et se terminent sur la même ligne de code. Ils com­men­cent par --.
• *Multi-Line Comments *: ces com­men­taires couvrent plusieurs lignes. Ils sont initiés par /* et se terminent par */.
• *Inline Comments *: ces com­men­taires sont une sous-catégorie des Multi-Line Comments. Ils sont insérés entre deux ins­truc­tions et sont également marqués par /* et */.

Single Line Comments

Les com­men­taires sur une seule ligne sont indiqués par deux tirets con­sé­cu­tifs. Tout ce qui est écrit après ces tirets dans la ligne cor­res­pon­dante 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é nor­ma­le­ment à partir du début de la ligne suivante. Ces com­men­taires ne doivent donc pas être terminés ex­pli­ci­te­ment par un caractère.

Pour mieux com­prendre le fonc­tion­ne­ment des com­men­taires, prenons un exemple concret. Dans le court extrait de code suivant, nous plaçons devant la commande SELECT un com­men­taire qui décrit plus en détail son uti­li­sa­tion.

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

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

Il est également possible d’insérer un tel com­men­taire après une ins­truc­tion. L’ins­truc­tion et le com­men­taire peuvent être placés sur la même ligne, à condition que ce dernier suive l’ins­truc­tion. 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

Multi-Line Comments

Les com­men­taires SQL mul­ti­lignes sont struc­tu­rés dif­fé­rem­ment. Ils né­ces­si­tent ex­pli­ci­te­ment 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é­dem­ment :

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

Il est également possible d’utiliser ces SQL Comments pour empêcher l’exécution d’une certaine ins­truc­tion. Cela peut être utile si vous l’avez déjà utilisée, mais que vous souhaitez l’ignorer tem­po­rai­re­ment. Voici un exemple :

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

Bien que nous ayons défini ici cinq ins­truc­tions, le système n’appellera que la table des employés. Les factures, les mar­chan­dises, les retours et la liste des clients se trouvent dans le com­men­taire et sont donc ignorés.

Inline Comments

Les com­men­taires en ligne sont une variante des com­men­taires mul­ti­lignes habituels. Ils se dis­tin­guent par des dé­li­mi­teurs de début et de fin clai­re­ment définis, ce qui permet de les insérer même au milieu des ins­truc­tions. Il est crucial de veiller à ne pas perturber la li­si­bi­lité du code. Cependant, pour fournir des ex­pli­ca­tions dé­tail­lées sur un segment précis d’une ligne, ces com­men­taires sont par­ti­cu­liè­re­ment ap­pro­priés. Voici un exemple il­lus­trant comment utiliser un tel com­men­taire :

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

Le système affichera librement toute la table nommée « Employés » et toutes ses colonnes et champs. Le com­men­taire ne sera visible que par vous ou par un autre uti­li­sa­teur du code.