¿Por qué escribir comentarios en el código?
Cuando se crea un script en un archivo, en ocasiones es necesario incluir texto en el código que no debe ejecutarse, para añadir comentarios que ayuden a la comprensión y lectura del código. Además, estos textos también se utilizan para añadir información adicional, como puede ser información sobre los desarrolladores, sobre la licencia o cualquier otra información relevante que no deba ser interpretada como código.
Escribir comentarios en el código
Estos textos que no deben ser ejecutados se pueden colocar escribiéndolos en la misma línea que el código, colocando el carácter almohadilla delante del texto para indicar que todo el texto situado entre este carácter y el final de la línea no debe ser interpretado, y todo el texto situado entre el inicio de la línea y el carácter almohadilla debe ser ejecutado como código de esta forma:
echo "Esto se ejecutara" #Esto es un comentarioO también se puede colocar el texto que no debe ser ejecutado en una nueva línea, colocando al inicio de la línea el carácter almohadilla, de forma que todo el texto situado entre este carácter y el final de la línea no será ejecutado, por ejemplo:
echo "Hola" #Esto es un comentario
#Esto tambien es un comentarioComentarios Multilínea
Scripting Bash no reconoce los Comentarios Multilínea. Por ello, se debe utilizar el carácter almohadilla (#) en cada línea donde haya texto que no deba ser interpretado.
Evita el Código Verboso
Al igual que en otros lenguajes de programación, en Scripting Bash, el uso abusivo de comentarios puede dar lugar a lo que se conoce como «código verboso», es decir, a un código confuso y difícil de entender debido al exceso de comentarios. Por ello, es esencial encontrar un equilibrio, y comentar solo cuando sea necesario para no comprometer la claridad del código.
Video sobre comentarios en scripting bash
Si queréis, podeis ver una explicación mas detalla en este video: