• Artículo

Comentarios

Los comentarios son cadenas de texto que no se ejecutan incluidas en el código de un programa; también se conocen como observaciones. Los comentarios se pueden usar para documentar código o partes deshabilitadas temporalmente de instrucciones y lotes de Transact-SQL que se están diagnosticando. La utilización de comentarios hace más fácil el mantenimiento futuro del código del programa. Los comentarios se usan, a menudo, para guardar el nombre de un programa, el nombre del autor y las fechas de los cambios importantes del código. Los comentarios se pueden usar para describir cálculos complejos o para explicar determinado método de programación.

SQL Server admite dos tipos de caracteres de comentario:

  • -- (doble guión). Estos caracteres para los comentarios se pueden usar en la misma línea que el código que se va a ejecutar o en una línea aparte. Todo lo que se encuentre entre los dos guiones y el final de la línea es parte del comentario. En el caso de que un comentario ocupe varias líneas, los guiones dobles deben aparecer antes de cada línea de comentarios. Para obtener más información acerca de cómo utilizar los caracteres de comentarios, vea -- (Comentarios) (Transact-SQL).

  • /* ... */ (pares de caracteres de barra diagonal y asterisco). Estos caracteres para los comentarios se pueden usar en la misma línea que el código que se va a ejecutar, en líneas separadas o, incluso, en el código ejecutable. Todo lo incluido entre el par de apertura de comentario (/*) y el par de cierre de comentario (*/) se considera parte del comentario. En un comentario de varias líneas, el par de caracteres de apertura de comentario (/*) debe iniciar el comentario y el par de caracteres de cierre de comentario (*/) debe finalizarlo. Para obtener más información acerca de cómo utilizar los caracteres de comentarios /* ... */ , vea /*...*/ (comentario de Transact-SQL).

Consideraciones

A continuación se muestra información básica acerca de los comentarios:

  • En los comentarios se pueden usar todos los caracteres o símbolos alfanuméricos. SQL Server pasa por alto todos los caracteres de un comentario, aunque el Editor de código de SQL Server Management Studio y sqlcmd buscarán GO como los dos primeros caracteres de las líneas de un comentario que ocupa varias.

  • No hay una longitud máxima para un comentario dentro de un lote. Un comentario puede contener una o más líneas.

Ejemplos

Estos son algunos ejemplos de comentarios válidos.

USE AdventureWorks;
GO
-- Single line comment.

SELECT EmployeeID, 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 ContactID, /* FirstName, */ LastName
FROM Person.Contact;

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