Cómo añadir comentarios en Bash Scripts

1. Comentarios de una sola línea en Bash
2. Comentarios multilínea en Bash

Los comentarios son las líneas que el intérprete ignora y sólo se utilizan para describir lo que está sucediendo en el código o para dar una idea de lo que está haciendo un bloque o una línea de código en particular. Los comentarios hacen que el código sea más fácil de entender para los que lo leen. Podemos describir lo que está sucediendo en el código en lenguaje humano usando comentarios. También puede ser útil cuando revisamos nuestro código después de un tiempo de escribirlo. Los comentarios también son útiles al depurar el código. En lugar de eliminar la parte que se sospecha que tiene un error, podemos comentar la parte en particular y depurar el código.

Podemos escribir comentarios en Bash usando # y heredoc. Generalmente, # se usa para escribir comentarios de una sola línea, y heredoc se usa para escribir comentarios de varias líneas.

Comentarios de una sola línea en Bash

Usamos símbolos # para escribir comandos de una sola línea en Bash. Después de #, todo es ignorado mientras se interpreta el script excepto la primera línea que contiene #!. Esta secuencia específica #! que aparece en la primera línea se llama Shebang, y se usa para decidir qué intérprete usar.

Los comentarios pueden comenzar desde el principio de la línea, o incluso pueden estar en línea con el código.

#!/bin/bash
echo "Hello World!" # echo is similar to print statement.
# end of the code

Resultado:

Hello World!

Aquí, la primera línea sugiere que el compilador a utilizar es /bin/bash.

En la segunda línea, tenemos el comentario en línea y en la tercera línea, tenemos un comentario que comienza desde el principio de la línea.

Comentarios multilínea en Bash

Bash no tiene soporte para comentarios de varias líneas. Una forma de escribir comentarios multilínea en Bash es usando un comentario de una sola línea para cada línea.

# This is a
# multiline comment in Bash
echo "Hello World!"

Resultado:

Hello World!

Aquí, las líneas 1 y 2 pueden ser consideradas como comentarios de varias líneas donde cada línea es interpretada como un comentario separado por el intérprete.

También podemos aprovechar Heredoc para escribir comandos multilínea. Heroc es un método para pasar entradas multilíneas a un comando. Podemos usar Heroc como un comentario multilínea si el Heredoc no es redirigido a ningún comando.

#!/bin/bash

<< 'Comment'
    Everything inside the
    HereDoc body is
    a multiline comment
Comment
echo "Hello World!" 

Resultado:

Hello World!

Aquí, las líneas 3-7 son consideradas como un comentario multilínea por el intérprete.