Mysql
 sql >> Base de données >  >> RDS >> Mysql

Comment tirer le meilleur parti de la fonction de commentaire dans MySQL

Les commentaires sont utilisés pour ajouter des informations au code. Il est généralement ignoré par le compilateur, mais les spécialistes humains peuvent lire ces commentaires lorsqu'ils visualisent votre code. Les commentaires sont essentiels pour les développeurs car ils disposent d'un temps limité, et les commentaires leur permettent d'obtenir immédiatement des informations précieuses ou de noter des détails cruciaux concernant le code. L'accès à ces données leur permet de prendre les bonnes décisions et de travailler plus rapidement.

En quoi les commentaires peuvent-ils m'être utiles ?

Les commentaires sont utiles pour vous personnellement et pour toute personne qui pourrait avoir besoin de lire ou de modifier ce code ultérieurement. Mais comment exactement ?

  • Les commentaires peuvent être des espaces réservés lors du codage. À ce moment-là, vous pourriez supposer quelque chose, et vous sauriez si votre hypothèse est vraie à l'avenir.
  • Les commentaires peuvent documenter vos pensées ou être des notes pour vous-même afin que vous n'oubliiez pas vos actions lorsque vous y reviendrez plus tard.
  • Vous pouvez inclure des commentaires sur ce que vous avez fait dans votre code pour que d'autres programmeurs le comprennent mieux et plus rapidement (le temps des codeurs coûte très, très cher).
  • Vous pouvez utiliser les commentaires pour désactiver ou activer temporairement les parties boguées.
  • L'ajout de commentaires sur chaque ligne d'un script facilite le suivi des bogues potentiels dans le programme.
  • Les commentaires peuvent expliquer ce que font certaines lignes de code ou pourquoi vous avez choisi une approche particulière pour éviter tout malentendu (par exemple, lorsque certaines parties du code sont destinées à une section ou à un objectif particulier que vous devez comprendre clairement) ,
  • Vous pouvez écrire un paragraphe entier expliquant tous les détails de la section de code si nécessaire pour les débutants ou les personnes d'autres projets. Les commentaires sont souvent nécessaires lors de l'écriture de requêtes SQL complexes avec de nombreuses clauses telles que INNER JOIN, GROUP BY, etc.
  • Les commentaires vous permettent de prendre des notes sur ce que vous faites. Cela aide les autres à comprendre comment et pourquoi vous avez fait quelque chose afin qu'ils puissent le maintenir ou le modifier au besoin.

SQL est-il un bon langage pour les commentaires ?

Oui! Les commentaires sont le plus souvent utilisés en conjonction avec des langages comme SQL et PHP où nous pouvons les insérer dans un fichier texte ou un script en utilisant la fonction de commentaire * / (par exemple, /* Ceci est mon commentaire */). Ils sont généralement aussi faciles à utiliser partout ailleurs.

Comment commenter en SQL ?

La fonction de commentaire vous permettra d'écrire n'importe quel texte pour ajouter un commentaire en SQL. Cela n'affecte pas la sortie finale tant qu'il vient avant ou après un caractère préprogrammé défini.

Pour ajouter des commentaires en SQL, vous pouvez utiliser les symboles suivants :/* */ ou # ou — (double tiret).

/* */ fonctionnera dans toutes les situations où vous souhaitez commencer et terminer votre commentaire à ce stade sans utiliser quoi que ce soit d'autre (comme des guillemets simples).

# est utilisé pour une ligne de code à la fois

— s'applique également pour une ligne de code à la fois. N'oubliez pas de mettre un espace après ce double tiret.

Dans votre code, cela ressemblerait à ceci :

-- this is a comment
# this is also a comment
/*
   multiline
   comment
*/

Voici la différence entre les commentaires sur une ligne et sur plusieurs lignes :

mysql> SELECT 1+1;     # This comment continues to the end of line
mysql> SELECT 1+1;     -- This comment continues to the end of line
mysql> SELECT 1 /* this is an in-line comment */ + 1;
mysql> SELECT 1+
/*
this is a
multiple-line comment
*/
1;

Voici un autre exemple de commentaire sur plusieurs lignes :

SELECT contact_id, last_name, first_name
/*
 * Author: TechOnTheNet.com
 * Purpose: To show a comment that spans multiple lines in your SQL
 * statement in MySQL.
 */
FROM contacts;

Commentaire à l'aide du symbole #

Les commentaires de hachage de base style peut être inséré dans le texte comme ceci :

Select * from users ; # this will list users

Commentaire à l'aide du double tiret (–)

C'est plus ou moins la même chose (n'oubliez pas l'espace). Le SQL standard ne vous oblige pas à utiliser cet espace, mais MySQL l'utilise pour éviter les problèmes avec des commandes telles que SELECT 10–1.

Select * from users ; -- this will list users

Commentaire à l'aide des symboles / * et * /

Ce commentaire multiligne, contrairement aux deux exemples précédents, ne doit pas s'arrêter à la fin de la ligne.

Select * from users ; /* this will list users */

Commentaires exécutables

En règle générale, les commentaires sont ignorés par quiconque est à l'autre bout (car ils sont réservés aux programmeurs), mais certains types de commentaires - commentaires exécutables - permettent au code de s'exécuter sur certains systèmes.

Dans notre cas, les commentaires exécutables vous permettent d'utiliser des codes SQL qui seront exécutés uniquement dans MYSQL, pas dans d'autres bases de données.

Les commentaires exécutables doivent être contenus entre barres obliques suivies d'un astérisque , comme avec le code habituel :

/* ! Code spécifique à MySQL */

Cependant, ces commentaires exécutables nécessitent une syntaxe spécifique comme ci-dessous :

/*!##### Code spécifique à MySQL */

Vous avez besoin du  !##### partie pour signaler les commentaires exécutables. Il représente la version minimale de MYSQL pouvant exécuter des commentaires.

Au lieu du premier hachage, remplacez la version principale de MYSQL. Au lieu de la seconde, la version la plus récente et les versions du patch sont remplacées par les 2 dernières.

Seul MySQL 5.1.10 ou une version ultérieure peut exécuter les commentaires suivants :

CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */

Conclusion

Les commentaires facilitent la lecture des programmes en ajoutant plus de détails. Vous pouvez les considérer comme quelque peu similaires aux hachages - ils réduisent le temps nécessaire pour comprendre le code ou en identifier certaines parties de manière drastique en fournissant des extraits qui capturent l'essence du texte. Si vous avez déjà travaillé avec des preuves sans connaissance ou essayé de vous connecter à Facebook via Google, vous saurez ce que nous voulons dire.

C'est pourquoi il est primordial de commenter son code et de savoir le faire correctement. Garder votre code précis avec des notes informatives facilite la vie de tous les spécialistes impliqués.