Introducción
Al escribir scripts Bash, siempre es una buena idea hacer que el código sea limpio y fácil de entender. Organizar el código en bloques, sangrar, asignar variables y funciones a nombres descriptivos son varias formas de hacerlo.
Otra forma de mejorar la legibilidad de su código es utilizar comentarios. Un comentario es una explicación o anotación legible por humanos escrita en el script de shell.
Agregar comentarios a sus scripts Bash le ahorrará mucho tiempo y esfuerzo al mirar su código en el futuro. Supongamos que desea cambiar un guión que escribió hace unos meses o años. Lo más probable es que no recuerde por qué escribió un código complicado si no agregó un comentario.
Los comentarios también ayudan a otros desarrolladores y administradores de sistemas que pueden necesitar mantener el script para comprender el código y su propósito.
Los comentarios se utilizan generalmente para explicar lo que el código no puede. Por ejemplo, si tiene una expresión regular compleja o una sustitución de parámetros dentro de su script Bash, debe escribir un comentario sobre lo que hace el código. Los comentarios deben ser breves y directos. No explique algo que sea simple y obvio para el lector.
En este artículo, cubriremos los conceptos básicos para escribir comentarios en Bash.
Escribir comentarios en Bash
Bash ignora todo lo escrito después del signo de almohadilla ( # ) en la línea. ¡La única excepción a esta regla es cuando la primera línea del script comienza con i #! caracteres. Esta secuencia de caracteres se llama Shebang y se utiliza para indicarle al sistema operativo qué intérprete utilizar para analizar el resto del archivo.
Los comentarios se pueden agregar al principio de la línea o en línea con otros códigos:
# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.
No se requiere espacio en blanco después de la marca de almohadilla, pero mejorará la legibilidad del comentario.
Normalmente, cuando se abre el script en un editor de texto, los comentarios se representan en verde.
Los comentarios también son útiles cuando se prueba un script. En lugar de eliminar algunas líneas o bloques, puede comentarlos:
# if [[ $VAR -gt 10 ]]; then
# echo "Variable is greater than 10."
# fi
Comentarios multilínea en Bash
A diferencia de la mayoría de los lenguajes de programación, Bash no admite comentarios de varias líneas.
La forma más sencilla de escribir comentarios de varias líneas en Bash es agregar comentarios individuales uno tras otro:
# This is the first line.
# This is the second line.
Otra opción es utilizar HereDoc. Es un tipo de redireccionamiento que le permite pasar múltiples líneas de entrada a un comando. Si el bloque HereDoc no se redirige a un comando, puede servir como marcador de posición para comentarios de varias líneas:
<< 'MULTILINE-COMMENT'
Everything inside the
HereDoc body is
a multiline comment
MULTILINE-COMMENT
Usar HereDoc es un truco, no una forma realmente incorporada de escribir comentarios Bash de varias líneas. Para evitar problemas, es preferible utilizar comentarios de una sola línea.
Conclusión
Escribir comentarios es una buena práctica y ayuda a otros desarrolladores, incluido el yo futuro, a comprender el script de shell. En Bash, todo lo que sigue al signo de almohadilla ( # ) y hasta el final de la línea se considera un comentario.
