Escribir comentarios en guiones bash

Al escribir scripts de Bash, siempre es una buena práctica hacer que su código sea limpio y fácilmente comprensible. Organizar su código en bloques, sangrar, asignar nombres descriptivos a las variables y funciones son varias formas de hacerlo.

Otra forma de mejorar la legibilidad de su código es mediante el uso de comentarios. Un comentario es una explicación o anotación legible para humanos que se escribe en el script de shell.

Agregar comentarios a sus scripts de Bash le ahorrará mucho tiempo y esfuerzo cuando vea su código en el futuro. Digamos que desea cambiar un guión que escribió hace unos meses o años. Lo más probable es que no recuerdes por qué escribiste un código complicado a menos que hayas agregado un comentario.

Los comentarios también ayudan a otros desarrolladores y administradores de sistemas que pueden necesitar mantener el script para comprender su código y su propósito.

Los comentarios se usan 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 cortos y al grano. No explique algo que sea simple y obvio para el lector.

, cubriremos los conceptos básicos de escribir comentarios en Bash.

Escribir comentarios en Bash

Bash ignora todo lo que se escribe después de la marca hash ( # ) en la línea. La única excepción a esta regla es cuando la primera línea del script comienza con el #! caracteres. Esta secuencia de caracteres se llama Shebang y se usa para indicarle al sistema operativo qué intérprete usar para analizar el resto del archivo.

Los comentarios se pueden agregar al principio en la línea o en línea con otro código:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

El espacio en blanco después de la marca hash no es obligatorio, pero mejorará la legibilidad del comentario.

Por lo general, cuando el script se abre en un editor de texto, los comentarios se representan en verde.

Los comentarios también son útiles al probar un script. En lugar de eliminar algunas líneas o bloques, puede comentarlos:

# if]; 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 multilínea.

La forma más sencilla de escribir comentarios multilínea en Bash es agregar comentarios individuales uno tras otro:

# This is the first line. # This is the second line.

Otra opción es usar HereDoc. Es un tipo de redirección 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 de 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 real de escribir comentarios Bash multilínea. Para evitar cualquier problema, debe preferir usar comentarios de una sola línea.

Conclusión

Escribir comentarios es una buena práctica y ayuda a otros desarrolladores, incluido el futuro, a comprender el script de shell. En Bash, todo después de la marca hash ( # ) y hasta el final de la línea se considera un comentario.

Si tiene alguna pregunta o comentario, no dude en dejar un comentario.

terminal de bash