Los comentarios se utilizan para agregar información al código. El compilador lo ignora en su mayoría, pero los especialistas humanos pueden leer esos comentarios cuando ven su código. Los comentarios son esenciales para los desarrolladores porque tienen un tiempo limitado, y comentar les permite obtener información valiosa de una vez o anotar algunos detalles cruciales con respecto al código. Acceder a estos datos les permite tomar las decisiones correctas y trabajar más rápido.
¿Cómo me pueden ser útiles los comentarios?
Los comentarios son útiles para usted personalmente y para cualquier persona que necesite leer o editar este código más adelante. Pero, ¿cómo exactamente?
- Los comentarios pueden ser marcadores de posición al codificar. En ese momento, podría asumir algo y sabría si su suposición es cierta en el futuro.
- Los comentarios pueden documentar sus pensamientos o ser notas para usted mismo para que no olvide sus acciones cuando regrese a ellos más tarde.
- Puedes incluir comentarios sobre lo que has hecho en tu código para que otros programadores lo entiendan mejor y más rápido (el tiempo de los codificadores es muy, muy caro).
- Puede usar los comentarios para deshabilitar o habilitar temporalmente partes con errores.
- Comentar en cada línea de un script simplifica el seguimiento de dónde pueden estar los errores dentro del programa.
- Los comentarios pueden explicar qué están haciendo ciertas líneas de código, o por qué eligió un enfoque particular para evitar malentendidos (por ejemplo, cuando algunas partes del código están destinadas a alguna sección o el propósito particular que debe entender claramente) ,
- Puedes escribir un párrafo entero explicando todos los detalles sobre la sección de código si es necesario para novatos o personas de otros proyectos. A menudo se necesitan comentarios cuando se escriben consultas SQL complejas con muchas cláusulas como INNER JOIN, GROUP BY, etc.
- Comentar te permite tomar notas sobre lo que estás haciendo. Esto ayuda a otros a comprender cómo y por qué hizo algo para que puedan mantenerlo o modificarlo según sea necesario.
¿Es SQL un buen lenguaje para comentarios?
¡Sí! Los comentarios se usan con mayor frecuencia junto con lenguajes como SQL y PHP, donde podemos insertarlos en un archivo de texto o secuencia de comandos mediante la función de comentario * / (por ejemplo, /* Este es mi comentario */). Por lo general, también son tan fáciles de usar en cualquier otro lugar.
¿Cómo comentar en SQL?
La función de comentario le permitirá escribir cualquier texto para agregar un comentario en SQL. No afecta la salida final siempre que se presente antes o después de un carácter preprogramado definido.
Para agregar comentarios en SQL, puede usar los siguientes símbolos:/* */ o # o — (doble guión).
# se usa para una línea de código a la vez
— también se aplica a una línea de código a la vez. No olvides dejar un espacio después de este doble guión.
En su código se vería de la siguiente manera:
-- this is a comment# this is also a comment/*
multiline
comment
*/
Esta es la diferencia entre los comentarios de una línea y de varias líneas:
mysql> SELECT 1+1; # This comment continues to the end of line
mysql> SELECT 1+1; -- This comment continues to the end of line
mysql> SELECT 1 /* this is an in-line comment */ + 1;
mysql> SELECT 1+
/*
this is a
multiple-line comment
*/
1;
Este es otro ejemplo de un comentario de varias líneas:
SELECT contact_id, last_name, first_name
/*
* Author: TechOnTheNet.com
* Purpose: To show a comment that spans multiple lines in your SQL
* statement in MySQL.
*/
FROM contacts;
Comentar usando el símbolo #
Los comentarios hash básicos El estilo se puede insertar en un texto como este:
Select * from users ; # this will list usersComentar usando el guión doble (–)
Esto es más o menos lo mismo (no olvides el espacio). El SQL estándar en realidad no requiere que uses el espacio allí, pero MySQL lo usa para evitar problemas con comandos como SELECT 10–1.
Select * from users ; -- this will list usersComentar utilizando los símbolos / * y * /
Este comentario de varias líneas, a diferencia de los dos ejemplos anteriores, no tiene que detenerse al final de la línea.
Select * from users ; /* this will list users */Comentarios ejecutables
Como regla general, los comentarios son ignorados por quien esté del otro lado (porque son solo para programadores), pero algunos tipos de comentarios (comentarios ejecutables) permiten que el código se ejecute en algunos sistemas.
En nuestro caso, los comentarios ejecutables le permiten usar códigos SQL que se ejecutarán solo en MYSQL, no en otras bases de datos.
Los comentarios ejecutables deben estar contenidos dentro de barras inclinadas con asterisco , como con el código habitual:
Sin embargo, estos comentarios ejecutables requieren una sintaxis específica como la siguiente:
/*!##### Código específico de MySQL */
Necesitas el !##### parte para señalar los comentarios ejecutables. Representa la versión mínima de MYSQL que puede ejecutar comentarios.
En lugar del primer hash, sustituya la versión principal de MYSQL. En lugar de la segunda, se sustituyen las 2 últimas por la versión más joven y las versiones del parche.
Solo MySQL 5.1.10 o una versión posterior puede ejecutar los siguientes comentarios:
CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */
Conclusión
Los comentarios facilitan la lectura de los programas al agregar más detalles. Puede pensar en ellos como algo similar a los hashes:reducen el tiempo requerido para comprender el código o identifican algunas partes de él drásticamente al proporcionar fragmentos que capturan la esencia del texto. Si alguna vez trabajó con pruebas de conocimiento cero o intentó iniciar sesión en Facebook a través de Google, sabrá a qué nos referimos.
Por eso es fundamental comentar tu código y saber cómo hacerlo correctamente. Mantener su código preciso con notas informativas facilita la vida de todos los especialistas involucrados.
