Partager via

  • Article

Commentaires

Les commentaires sont des chaînes de texte non exécutables dans le code d'un programme, également appelées notes. Les commentaires peuvent être utilisés pour documenter du code ou désactiver temporairement des parties d'instructions et de traitements Transact-SQL en cours d'analyse. L'utilisation de commentaires pour documenter le code facilite sa maintenance dans le temps. Les commentaires servent fréquemment à enregistrer le nom du programme, le nom de l'auteur et les dates des principales mises à jour. Les commentaires peuvent servir à décrire des calculs complexes ou à expliquer une méthode de programmation.

SQL Server prend en charge deux types de caractères de commentaire :

  • -- (double trait d'union). Ces caractères de commentaire peuvent être utilisés directement dans une ligne de code ou en début de ligne. Tout ce qui se trouve entre les doubles tirets et la fin de ligne fait partie du commentaire. Pour un commentaire de plusieurs lignes, les doubles tirets doivent apparaître en face de chaque ligne. Pour plus d'informations sur l'utilisation des caractères de commentaire, consultez '-- (Comment) (Transact-SQL).

  • /* ... */ (paires de caractères barre oblique-astérisque). Ces caractères de commentaires peuvent être utilisés directement dans une ligne de code devant être exécuté, en début de ligne ou même dans du code exécutable. Tout ce qui se trouve entre le commentaire ouvrant (/*) et le commentaire fermant (*/) est considéré comme du commentaire. Dans le cas d'un commentaire de plusieurs lignes, les deux caractères du commentaire ouvrant (/*) doivent débuter le commentaire, et ceux du commentaire fermant (*/) le terminer. Pour plus d'informations sur l'utilisation des caractères de commentaire /* ... */, consultez /*...*/ (Commentaire) (Transact-SQL).

Observations

Vous trouverez ci-dessous des informations de base sur les commentaires :

  • Tous les caractères alphanumériques ou les symboles peuvent être utilisés dans un commentaire. SQL Server ignore tous les caractères dans un commentaire, bien que l'éditeur de code SQL Server Management Studio et sqlcmd recherchent l'instruction GO dans les deux premiers caractères de toutes les lignes d'un commentaire.

  • La longueur d'un commentaire n'est pas limitée. Un commentaire peut comprendre une ou plusieurs lignes.

Exemples

Voici quelques exemples de commentaires valides :

USE AdventureWorks2008R2;
GO
-- Single line comment.

SELECT BusinessEntityID, Title
FROM HumanResources.Employee;
GO

/* First line of a multiple-line comment.
   Second line of a multiple-line comment. */
SELECT Name, ProductNumber, Color
FROM Production.Product;
GO

-- Using a comment in a Transact-SQL statement
-- during diagnosis.
SELECT BusinessEntityID, /* FirstName, */ LastName
FROM Person.Person;

-- Using a comment after the code on a line.
USE AdventureWorks2008R2;
GO
UPDATE Production.Product
SET ListPrice = ListPrice * .9; -- Reduce price to build market share.
GO