Un excellent moyen d'aider à maintenir et à améliorer la lisibilité à vos déclarations SQL est l'utilisation de commentaires. Par exemple, vous pouvez ajouter des commentaires au document ou décrire la lucidité du script. Étant donné que le serveur SQL n'exécute pas les commentaires SQL, nous pouvons également les utiliser pour désactiver un bloc de code spécifique, vous permettant de déboguer et de refactoriser votre code.
Ce tutoriel apprendra à utiliser et à ajouter des commentaires à vos requêtes SQL. Nous discuterons de la façon d'utiliser des commentaires unique et multi-lignes dans SQL Server.
Les bases
Il existe deux façons principales pour créer des commentaires dans vos requêtes SQL. Le premier utilise un double tiret, et l'autre utilise une barre oblique et un astérisque.
Laissez-nous apprendre à créer des commentaires en utilisant les syntaxes décrits ci-dessus.
Commentaires à une seule ligne
Pour créer un commentaire à une seule ligne dans les requêtes SQL Server, utilisez le symbole. La syntaxe est comme indiqué:
-- comment_TextLorsque SQL Server rencontre une ligne qui commence par le symbole, il ignorera tout le contenu jusqu'à la fin de la ligne. Le nouveau personnage de ligne agit comme la valeur finale d'un commentaire à commencer par - Symboles.
Considérez l'exemple ci-dessous:
-- Obtenez 5 valeurs de la table des clientsDans l'exemple de requête SQL ci-dessus, nous utilisons un commentaire à une seule ligne pour ajouter une description de l'action effectuée par l'instruction SQL qui suit.
Il est bon de noter qu'il n'y a pas de limite maximale pour le nombre de caractères qu'un commentaire contient.
En utilisant Microsoft SQL Server Management Studio, vous pouvez ajouter un commentaire à une seule ligne à l'aide du raccourci clavier Ctrl + K, Ctrl + C.
Vous pouvez également utiliser l'interface graphique en cliquant sur l'icône ci-dessous dans la barre d'outils principale.
Une fois que vous avez sélectionné et utilisé les raccourcis du clavier ou l'icône de commentaire, le serveur SQL ajoutera deux tirets et commentera la ligne définie.
Commentaires multi-lignes
L'autre type de commentaire est les commentaires multi-lignes ou bloqués. Ce sont le type de commentaires qui s'étendent plus qu'une seule ligne, comme un paragraphe.
Disons que vous souhaitez commenter les lignes suivantes:
-- Obtenez le prénom des clientsVous remarquez que nous devons ajouter deux commentaires à une seule ligne. Cette méthode rend le code illisible et répétitif.
Nous pouvons résoudre ce problème en insérant un commentaire multi-lignes en utilisant la syntaxe ci-dessous:
/ * commenter iciSQL Server utilise A / * pour ouvrir un commentaire multi-ligne et * / pour fermer le bloc de commentaires. SQL Server ignorera tout texte spécifié dans ces blocs.
Considérez l'exemple de code ci-dessous:
Les commentaires en plusieurs lignes sont très utiles lorsque vous avez des commentaires qui étendent plusieurs lignes. Vous pouvez également les utiliser pour afficher des informations utiles telles que l'auteur, la date et plus.
/ *De même, les commentaires de blocs peuvent désactiver plusieurs requêtes SQL.
Conclusion
Ce guide vous apprend à travailler avec les commentaires SQL Server pour ajouter des informations à vos scripts SQL. Le commentaire du code aide à améliorer la lisibilité et la maintenance du code par d'autres développeurs. Prendre l'habitude de commenter votre code.
Merci d'avoir lu.