Comentarios del servidor SQL

Las declaraciones SQL son significativas para interactuar y trabajar con sus bases de datos. Dichas declaraciones pueden ser una sola línea de código o consultas de múltiples líneas. Si tiene muchas declaraciones SQL, puede ser difícil conocer el propósito previsto del código.

Una excelente manera de ayudar a mantener y mejorar la legibilidad en sus declaraciones SQL es el uso de comentarios. Por ejemplo, puede agregar comentarios al documento o describir la lucidez del script. Dado que el servidor SQL no ejecuta comentarios de SQL, también podemos usarlos para desactivar un bloque de código específico, lo que le permite depurar y refactorizar su código.

Este tutorial aprenderá a usar y agregar comentarios a sus consultas SQL. Discutiremos cómo usar comentarios de una sola línea y múltiples en SQL Server.

Los basicos

Hay dos formas principales que puede usar para crear comentarios en sus consultas SQL. El primero usa un doble tablero, y el otro usa un corte hacia adelante y un asterisco.

Aprendamos cómo crear comentarios usando las sintaxis descritas anteriormente.

Comentarios de una sola línea

Para crear un comentario de una sola línea en las consultas de SQL Server, use el símbolo -. La sintaxis es como se muestra:

-- comment_text

Cuando SQL Server encuentra una línea que comienza con el símbolo, ignorará todo el contenido al final de la línea. El nuevo personaje de línea actúa como el valor final para un comentario que comienza con los símbolos.

Considere el ejemplo que se muestra a continuación:

-- Obtenga 5 valores de la tabla de clientes
Seleccione Top 5 * de los clientes;

En la consulta SQL de ejemplo anterior, utilizamos un comentario de una sola línea para agregar una descripción de la acción realizada por la declaración SQL que sigue.

Es bueno tener en cuenta que no hay un límite máximo para el número de caracteres que contiene un comentario.

Usando Microsoft SQL Server Management Studio, puede agregar un comentario de una sola línea utilizando el acceso directo de teclado Ctrl + K, Ctrl + C.

También puede usar la interfaz gráfica haciendo clic en el icono que se muestra a continuación en la barra de herramientas principal.

Una vez que seleccione y use los atajos de teclado o el icono de comentarios, el servidor SQL agregará dos guiones y comentará en la línea de configuración.

Comentarios de múltiples líneas

El otro tipo de comentario son los comentarios de múltiples líneas o bloque. Estos son el tipo de comentarios que abarcan más de una sola línea, como un párrafo.

Digamos que desea comentar las siguientes líneas:

-- Obtenga el primer nombre del cliente
-- Obtenga el apellido del cliente
Seleccione Top 5 FirstName, LastName de los clientes;

Notas que tenemos que agregar dos comentarios de una sola línea. Este método hace que el código sea ilegible y repetitivo.

Podemos solucionar esto insertando un comentario de varias líneas utilizando la sintaxis que se muestra a continuación:

/* Comenta aquí
otra línea
y otro
*/

SQL Server usa A / * para abrir un comentario de múltiples líneas y * / para cerrar el bloque de comentarios. SQL Server ignorará cualquier texto especificado en esos bloques.

Considere el código de ejemplo que se muestra a continuación:

Los comentarios de varias líneas son muy útiles cuando tiene comentarios que extienden varias líneas. También puede usarlos para mostrar información útil como autor, fecha y más.

/*
Autor: Linuxhint;
Categoría: SQL Server;
Pub: 2022;
*/
Seleccione Top 5 FirstName, LastName de los clientes;

Del mismo modo, los comentarios de bloque pueden deshabilitar múltiples consultas SQL.

Conclusión

Esta guía le enseña cómo trabajar con los comentarios de SQL Server para agregar información a sus scripts SQL. Comentar sobre el código ayuda a mejorar la legibilidad y el mantenimiento del código por parte de otros desarrolladores. Acostúmbrese a comentar su código.

Gracias por leer.