SQL Comments: aprende a añadir co­me­n­ta­rios a un código

Los SQL Comments se utilizan para colocar co­me­n­ta­rios di­re­c­ta­me­n­te dentro del código. Podemos di­fe­re­n­ciar entre co­me­n­ta­rios 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 pro­gra­ma­ción, el lenguaje de consultas es­tru­c­tu­ra­das (SQL) también da la po­si­bi­li­dad de colocar co­me­n­ta­rios dentro del código que son legibles, pero no tienen re­pe­r­cu­sio­nes en la ejecución. Estos se pueden usar de formas di­fe­re­n­tes. Por ejemplo, los SQL Comments pueden emplearse para explicar con más detalle ciertas áreas dentro del código, lo que es es­pe­cia­l­me­n­te útil si más adelante tienes que revisar el código u otra persona debe trabajar en él. Un co­me­n­ta­rio también puede uti­li­zar­se para impedir que se ejecute un comando SQL.

Los SQL Comments pueden dividirse en dos o tres ca­te­go­rías en función de su in­te­r­pre­ta­ción:

• Co­me­n­ta­rios de una sola línea: comienzan y terminan en la misma línea de código. Se inician con --.
• Co­me­n­ta­rios de varias líneas: abarcan múltiples líneas. Comienzan con /* y terminan con */.
• Co­me­n­ta­rios en línea: son una su­b­ca­te­go­ría de los co­me­n­ta­rios de varias líneas. Se insertan entre dos in­s­tru­c­cio­nes y también se delimitan con /* y */.

Co­me­n­ta­rios de una sola línea

Los co­me­n­ta­rios de una sola línea comienzan con dos guiones co­n­se­cu­ti­vos. Todo lo que se escriba después de estos guiones en la línea co­rre­s­po­n­die­n­te 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 eje­cu­tar­se, por lo que los co­me­n­ta­rios de una sola línea no tienen que te­r­mi­nar­se ex­plí­ci­ta­me­n­te con un carácter.

Para co­m­pre­n­der mejor cómo funcionan, fíjate en el siguiente ejemplo. En él, se coloca un co­me­n­ta­rio 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 in­fo­r­ma­ción del código a partir de SELECT.

También es posible insertar un co­me­n­ta­rio de una sola línea después de una in­s­tru­c­ción. La in­s­tru­c­ción y el co­me­n­ta­rio pueden estar en la misma línea siempre y cuando el co­me­n­ta­rio se sitúe después de la in­s­tru­c­ción (y no al revés).

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

Co­me­n­ta­rios de varias líneas

Los SQL Comments que ocupan varias líneas funcionan de manera un poco diferente, ya que deben estar de­li­mi­ta­dos 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 co­me­n­ta­rios de SQL para evitar que se ejecute una in­s­tru­c­ción es­pe­cí­fi­ca, por ejemplo si ya la has utilizado y la quieres ignorar te­m­po­ra­l­me­n­te. Ilu­s­tra­mos 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 pro­po­r­cio­na­do cinco in­s­tru­c­cio­nes, el sistema solo llamará a la tabla de “Empleados”. Los registros para “Facturas”, “Entradas de mercancía”, “De­vo­lu­cio­nes” y“Lista de clientes” están dentro del co­me­n­ta­rio y, por lo tanto, se ignoran.

Co­me­n­ta­rios en línea

Los co­me­n­ta­rios en línea son una su­b­ca­te­go­ría de los co­me­n­ta­rios de varias líneas. Al tener un inicio y un fin cla­ra­me­n­te marcados, también pueden colocarse entre las in­s­tru­c­cio­nes, pero es im­po­r­ta­n­te que no in­te­rru­m­pan demasiado la fluidez de lectura. Pueden ser una buena opción cuando necesitas explicar en detalle una parte es­pe­cí­fi­ca 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 co­me­n­ta­rio solo puedes verlo tú y las personas que trabajen con el código.