Comentarios MySQL

1. Comentarios de línea única de MySQL
2. Comentario de varias líneas en MySQL
3. Comentarios ejecutables de MySQL
4. Conclusión

En este artículo, presentaremos los comentarios de MySQL. También aprenderemos dónde y qué tipo de comentario se debe usar.

Los Comentarios están escritos para describir el código, para que sea fácil de entender. También usamos comentarios para ignorar una cierta parte del código mientras analizamos las consultas SQL (no permita que se ejecute esa parte del código).

También ayuda a los otros programadores a comprender lo que sucede en el código. Veremos cómo podemos usar comentarios de una y varias líneas en MySQL. También echaremos un vistazo a los comentarios ejecutables y sus usos.

Hay tres formas diferentes de escribir comentarios MySQL. Podemos usar los símbolos #, -, o /* y */ para comentar.

Comentarios de línea única de MySQL

Podemos usar los comentarios de una sola línea de MySQL de dos maneras, ya sea usando # o -.

Vamos a crear una tabla llamada tb_teachers para practicar los comentarios de MySQL. Usamos # para escribir un comentario de una sola línea en la consulta de MySQL que se muestra a continuación.

Este comentario se usa al final de la consulta SQL y debe tener un salto de línea después. Si no usa un salto de línea después del comentario, todo lo que viene en la misma línea se comentará hasta que encuentre un salto de línea. No es necesario poner un espacio en blanco después de #. Pero es un buen enfoque tener un espacio en blanco después de # para aumentar la legibilidad.

Código de ejemplo de MySQL usando #:

# Following SQL query will create a table named 'tb_teachers'
CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
 TEACHER_ID	INTEGER NOT NULL,
 FIRST_NAME	VARCHAR(30) NOT NULL,
 LAST_NAME	VARCHAR(30) NOT NULL,
 GENDER	VARCHAR(30) NOT NULL,
 CITY	VARCHAR(64) NOT NULL,
 EMAIL	VARCHAR(64) NOT NULL,
 JOINING_YEAR INTEGER NOT NULL,
 PRIMARY KEY	(TEACHER_ID)
);

Vea el siguiente ejemplo de código donde no colocamos un salto de línea después de usar un comentario de una sola línea. Puedes ver que el comando CREATE también está parcialmente comentado.

# Following SQL query will create a table named 'tb_teachers' CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
 TEACHER_ID	INTEGER NOT NULL,
 FIRST_NAME	VARCHAR(30) NOT NULL,
 LAST_NAME	VARCHAR(30) NOT NULL,
 GENDER	VARCHAR(30) NOT NULL,
 CITY	VARCHAR(64) NOT NULL,
 EMAIL	VARCHAR(64) NOT NULL,
 JOINING_YEAR INTEGER NOT NULL,
 PRIMARY KEY	(TEACHER_ID)
);

También podemos usar este tipo de comentario dentro de la consulta SQL. Consulte el siguiente fragmento de código; puedes observar que podemos comentar dentro de la consulta SQL usando #.

# Following SQL query will create a table named 'tb_teachers' 
CREATE TABLE `practice_mysql_comments`.`tb_teachers` (
 TEACHER_ID	INTEGER NOT NULL, # teacher's id
 FIRST_NAME	VARCHAR(30) NOT NULL, # teacher's first name
 LAST_NAME	VARCHAR(30) NOT NULL, # teacher's last name
 GENDER	VARCHAR(30) NOT NULL, # teacher's gender
 CITY	VARCHAR(64) NOT NULL, # teacher's home town
 EMAIL	VARCHAR(64) NOT NULL, # teacher's email
 JOINING_YEAR INTEGER NOT NULL, # teacher's appointment year
 PRIMARY KEY (TEACHER_ID) # primay key of the teacher's table
);

Exploremos la otra forma de comentarios de una sola línea usando el símbolo -. El siguiente código SQL muestra que podemos usar el símbolo doble - (guión) para comentar incluso dentro de la consulta SQL.

Es lo mismo que comentamos usando el símbolo # con una sola diferencia. Tenemos que poner al menos un espacio en blanco después del segundo guión; de lo contrario, no actuará como un comentario.

-- Following SQL query will create a table named 'tb_students' 
CREATE TABLE `practice_mysql_comments`.`tb_students` (
 STUDENT_ID	INTEGER NOT NULL, -- student's id
 FIRST_NAME	VARCHAR(30) NOT NULL, -- student's first name
 LAST_NAME	VARCHAR(30) NOT NULL, -- student;s last name
 GENDER	VARCHAR(30) NOT NULL, -- student's gender
 CITY	VARCHAR(64) NOT NULL, -- student's home town
 EMAIL	VARCHAR(64) NOT NULL, -- student's email
 REGISTRATION_YEAR INTEGER NOT NULL, -- student's registration year
 PRIMARY KEY (STUDENT_ID) -- primay key of the student's table
);

Comentario de varias líneas en MySQL

Si necesitamos explicar la consulta SQL en detalle para que el código sea fácil de entender, usamos comentarios de varias líneas. Todo lo que esté dentro de /* */ será ignorado. O pones un salto de línea al final de este tipo de comentario o no, no importa, pero es bueno tener un salto de línea para escribir un código limpio y organizado.

/* 
Following SQL query will create a table named 'tb_students'
having the basic information about the students. This information includes
full name, gender, city, email and registration year.
*/
CREATE TABLE `practice_mysql_comments`.`tb_students` (
 STUDENT_ID	INTEGER NOT NULL, 
 FIRST_NAME	VARCHAR(30) NOT NULL, 
 LAST_NAME	VARCHAR(30) NOT NULL, 
 GENDER	VARCHAR(30) NOT NULL, 
 CITY	VARCHAR(64) NOT NULL, 
 EMAIL	VARCHAR(64) NOT NULL,
 REGISTRATION_YEAR INTEGER NOT NULL, 
 PRIMARY KEY (STUDENT_ID) 
);

Aunque podemos tratar los comentarios de varias líneas como una sola línea, ¿por qué aumentar el esfuerzo cuando tenemos comentarios de una sola línea? Es bueno usar comentarios de varias líneas cuando no desea que se ejecute más de una línea. Vea el siguiente ejemplo.

/* 
Following SQL query will create a table named 'tb_students'
having the basic information about the students. This information includes
full name, gender, city, email and registration year.
*/
CREATE TABLE `practice_mysql_comments`.`tb_students` (
 STUDENT_ID	INTEGER NOT NULL, 
 FIRST_NAME	VARCHAR(30) NOT NULL, 
 LAST_NAME	VARCHAR(30) NOT NULL, 
 GENDER	VARCHAR(30) NOT NULL, 
 CITY	VARCHAR(64) NOT NULL, 
 /* EMAIL	VARCHAR(64) NOT NULL,
 REGISTRATION_YEAR INTEGER NOT NULL, */
 PRIMARY KEY (STUDENT_ID) 
);

Comentarios ejecutables de MySQL

MySQL también admite comentarios ejecutables. Este tipo de comentario le brinda portabilidad entre varias bases de datos. El código escrito dentro de estos comentarios solo se ejecutará en MySQL. Si especifica la versión después de ! carácter, solo funcionará en esa versión de MySQL en particular o superior.

Código de ejemplo de comentarios ejecutables:

SELECT 3 /*! *2 */ AS MULTIPLICATION;

Conclusión

Hemos concluido que los comentarios de MySQL juegan un papel vital durante la programación. No importa qué tipo de programación sea. Usar comentarios de varias líneas es una buena opción si tiene que ignorar más de una línea; de lo contrario, un comentario de una sola línea está bien. Puede usar los comentarios ejecutables de MySQL si desea que una determinada pieza de código se ejecute solo en el servidor MySQL.