SQL Comments: aprende a añadir comentarios a un código

Los SQL Comments se utilizan para colocar comentarios directamente dentro del código. Podemos diferenciar entre comentarios de una sola línea de código, varias líneas y en medio de la línea.

¿Qué son los SQL Comments?

Al igual que muchos lenguajes de bases de datos y lenguajes de programación, el lenguaje de consultas estructuradas (SQL) también da la posibilidad de colocar comentarios dentro del código que son legibles, pero no tienen repercusiones en la ejecución. Estos se pueden usar de formas diferentes. Por ejemplo, los SQL Comments pueden emplearse para explicar con más detalle ciertas áreas dentro del código, lo que es especialmente útil si más adelante tienes que revisar el código u otra persona debe trabajar en él. Un comentario también puede utilizarse para impedir que se ejecute un comando SQL.

Los SQL Comments pueden dividirse en dos o tres categorías en función de su interpretación:

• Comentarios de una sola línea: comienzan y terminan en la misma línea de código. Se inician con --.
• Comentarios de varias líneas: abarcan múltiples líneas. Comienzan con /* y terminan con */.
• Comentarios en línea: son una subcategoría de los comentarios de varias líneas. Se insertan entre dos instrucciones y también se delimitan con /* y */.

Comentarios de una sola línea

Los comentarios de una sola línea comienzan con dos guiones consecutivos. Todo lo que se escriba después de estos guiones en la línea correspondiente no se tiene en cuenta durante la ejecución, sino que sirve de anotación para explicar el código. El final de los SQL Comments coincide con el final de la línea. A partir del comienzo de la línea siguiente, el código vuelve a ejecutarse, por lo que los comentarios de una sola línea no tienen que terminarse explícitamente con un carácter.

Para comprender mejor cómo funcionan, fíjate en el siguiente ejemplo. En él, se coloca un comentario antes del comando SELECT que describe el propósito del código:

-- Llamar a todas las entradas de la tabla Empleados 
SELECT *
FROM Empleados;

Solo se tiene en cuenta la información del código a partir de SELECT.

También es posible insertar un comentario de una sola línea después de una instrucción. La instrucción y el comentario pueden estar en la misma línea siempre y cuando el comentario se sitúe después de la instrucción (y no al revés).

SELECT * -- selecciona todas las entradas
FROM Empleados; -- incluye la tabla denominada Empleados

Comentarios de varias líneas

Los SQL Comments que ocupan varias líneas funcionan de manera un poco diferente, ya que deben estar delimitados entre una barra lateral y un asterisco al inicio (/) y un asterisco y una barra lateral al final (/). El texto que se encuentre entre esos dos puntos se ignorará durante la ejecución del código. Para nuestro ejemplo anterior, tendría el siguiente aspecto:

/* Seleccionar todos los campos
en todas las filas
de toda la tabla denominada Empleados: */
SELECT *
FROM Empleados;

También es posible utilizar estos comentarios de SQL para evitar que se ejecute una instrucción específica, por ejemplo si ya la has utilizado y la quieres ignorar temporalmente. Ilustramos la situación en este ejemplo:

/ *SELECT*  FROM Facturas;
SELECT * FROM Entradas
SELECT * FROM Devoluciones;
SELECT  *FROM Lista de clientes;* /
SELECT * FROM Empleados;

Aunque en este caso hemos proporcionado cinco instrucciones, el sistema solo llamará a la tabla de “Empleados”. Los registros para “Facturas”, “Entradas de mercancía”, “Devoluciones” y“Lista de clientes” están dentro del comentario y, por lo tanto, se ignoran.

Comentarios en línea

Los comentarios en línea son una subcategoría de los comentarios de varias líneas. Al tener un inicio y un fin claramente marcados, también pueden colocarse entre las instrucciones, pero es importante que no interrumpan demasiado la fluidez de lectura. Pueden ser una buena opción cuando necesitas explicar en detalle una parte específica de una línea. En el siguiente ejemplo puedes ver cómo funcionan:

SELECT *
FROM / *Introduce aquí el nombre de la tabla* / Empleados;

El sistema mostrará toda la tabla llamada “Empleados” junto con todas sus columnas y campos. El comentario solo puedes verlo tú y las personas que trabajen con el código.