Cuando se escribe código SQL en Microsoft SQL Server, es importante incluir comentarios para hacer el código más comprensible y mantenible. Los comentarios son líneas de texto que se agregan al código pero no son leídas por la computadora durante la ejecución. Están destinados a que los humanos lean y comprendan el código.

Comentarios de una sola línea

La forma más común de agregar comentarios en SQL Server es mediante el uso de comentarios de una sola línea. Para crear un comentario de una sola línea, puedes poner dos guiones (–) al principio de la línea. Cualquier texto en esa línea después de los guiones será ignorado por el compilador. Por ejemplo:

-- Este es un comentario y será ignorado por SQL Server.

También puedes agregar comentarios al final de una línea de código usando dos guiones después del código. Por ejemplo:

UPDATE Sales.Invoices
SET DeliveryInstructions = 'Lánzalo al techo, por favor' -- Este es un comentario
WHERE InvoiceID = 7;

Comentarios de bloque o comentarios de varias líneas

Además de los comentarios de una sola línea, también puedes usar comentarios de bloque para comentar varias líneas de código a la vez. Para crear un comentario de bloque, puedes usar los caracteres /* y */ para indicar el inicio y el final del comentario. Cualquier texto entre estos caracteres será ignorado por el compilador. Por ejemplo:

/*
Este es un comentario y será ignorado por SQL Server.

Incluso si parece código, no se ejecutará.

UPDATE Sales.Invoices
SET DeliveryInstructions = 'Por favor, colóquelo junto a la puerta principal.'
WHERE InvoiceID = 7;
*/

Los comentarios de bloque también pueden ser útiles para comentar una parte interna de una sola línea de código. Por ejemplo:

UPDATE Sales.Invoices
SET /*InternalComments = 'El cliente está loco',*/ DeliveryInstructions = 'Toca fuerte'
WHERE InvoiceID = 7;

Mejores prácticas para comentar código

Cuando agregas comentarios a tu código SQL, es importante seguir algunas mejores prácticas para asegurarte de que los comentarios sean útiles y significativos:

• Incluye un encabezado de código que explique el propósito del código, cualquier parámetro y la salida.
• Explica secciones de código que no sean obvias o que puedan requerir contexto adicional.
• Incluye un historial de versiones que documente cualquier cambio realizado en el código, incluyendo el autor, la fecha y la razón del cambio.
• Utiliza comentarios descriptivos y significativos que proporcionen claridad y contexto.

Al seguir estas mejores prácticas, puedes hacer que tu código SQL sea más comprensible y más fácil de mantener tanto para ti como para otros desarrolladores.

Conclusión

Los comentarios son una parte esencial del código SQL en Microsoft SQL Server. Proporcionan información valiosa y contexto para ayudar a los desarrolladores a comprender el código y su propósito. Al utilizar comentarios de una sola línea y comentarios de bloque, y seguir las mejores prácticas para comentar código, puedes hacer que tu código SQL sea más legible y mantenible.

Última actualización del artículo: 2022-07-18