Commentaires

Pour un code de qualité, il faut commenter et le faire de manière intelligente. L'environnement de base de données n'échappe pas à cette règle.

Dans les options de table

Il est possible d'ajouter un commentaire dans les options d'une table. Il est possible d'ajouter ce commentaire à sa création ou à sa mise à jour. Attention, la taille du commentaire ne peut pas dépasser 60 caractères.

ALTER TABLE <table>
COMMENT = '<comment>'

Dans les options de colonne

Il est possible d'ajouter un commentaire dans les options d'une colonne. Il est possible d'ajouter ce commentaire à sa création ou à sa mise à jour. Attention, la taille du commentaire ne peut pas dépasser 255 caractères.

ALTER TABLE <table>
MODIFY COLUMN <column> <datatype> COMMENT '<comment>'

Dans les options de procédure stockée

Il est possible d'ajouter un commentaire dans les options d'une procédure stockée. Il est possible d'ajouter ce commentaire à sa création ou à sa mise à jour.

ALTER PROCEDURE <proc>
COMMENT '<comment>'

Dans la procédure stockée

Il est également recommandé d'ajouter des commentaires dans les procédures stockés et les scripts. Il existe trois syntaxes pour cela.

# Première syntaxe
# <comment>
 
-- Deuxième syntaxe
-- <comment>
 
/* Troisième syntaxe, peut être affiché sur plusieurs lignes */
/* <comment> */

Dans la requête

Il est possible d'ajouter un commentaire directement dans une requête SQL. Ce qui peut s'avérer très pratique lors de l'affichage des requêtes en cours d'exécution.

-- Première syntaxe
SELECT
/* <comment> */
<column>
FROM <table>
 
-- Deuxième syntaxe
SELECT
-- <comment>
<column>
FROM <table>