Cómo agregar comentarios en Bash

¿POR QUÉ AGREGAR COMENTARIOS?

Agregar comentarios en los scripts de Bash es una de las formas más efectivas de mantener un código limpio y comprensible.

Por poner un ejemplo, si tenemos una función completa, una parte de código difícil de entender, puede que agregando comentarios recordemos cómo funciona el código e incluso podemos ayudar a otros desarrolladores que miren nuestro código.

Comentar parte del código, también puede ayudarnos a debuggear nuestros scripts.

En este post veremos las diferentes formas de añadir comentarios a los scripts de Bash:

• Comentarios de una sola línea
• Comentarios en línea
• Comentarios de varias líneas

Agregar comentarios en el código ayuda a otros desarrolladores

1.- ELEMENTOS NECESARIOS PARA ESTE TUTORIAL

• Un equipo con GNU/Linux o Windows y WSL2

2.- COMENTARIOS DE UNA SOLA LÍNEA

Para agregar comentarios sencillos, en una sola línea, es tan sencillo como poner el símbolo (#) al principio de la línea y luego escribir nuestro comentario. En el ejemplo siguiente vemos claramente un "Hola Mundo", en Bash y con un sencillo comentario:

#!/bin/bash
# Comentario en una línea
echo "Hola Mundo"

Cuando ejecutemos el script, todos los comentarios serán ignorados y no se ejecutarán ni se mostrarán por pantalla. En la siguiente imagen vemos el código del script desde el editor de textos nano:

Comentario en una línea

Cuando ejecutemos el script, solamente se muestra el "Hola Mundo":

Hola Mundo

3.- COMENTARIOS EN LA MISMA LÍNEA

De forma similar a la anterior, podemos agregar comentarios de una línea, pero en la misma línea de código. Para ello debemos añadir el carácter (#) y detrás el comentario de lo que hace la línea en concreto:

Aquí os dejo un ejemplo sencillo:

#!/bin/bash
echo "Mi nombre es Raúl" # Esto es un comentario en línea

Cuando ejecutemos el script, todos los comentarios serán ignorados y no se ejecutarán ni se mostrarán por pantalla. En la siguiente imagen vemos el código del script desde el editor de textos nano:

Comentario en línea

Cuando ejecutemos el script, solamente se muestra el "Mi nombre es Raúl":

Mi nombre es Raúl

4.- COMENTARIOS EN VARIAS LÍNEAS

Los comentarios de varias líneas en los scripts de Bash nos permiten escribir comentarios en varias líneas o evitar la ejecución de un bloque de código colocándolos en la sección de comentarios de varias líneas. Existen tres formas diferentes de crear comentarios multilínea.

4.1.- BLOQUES DE COMENTARIOS UTILIZANDO #

Esta es la opción preferida cuando queremos explicar en el Head del script el funcionamiento del script e información adicionales de la versión, autor, email etc... Este tipo es utilizado por la mayoría de desarrolladores.  A continuación, os dejo un sencillo ejemplo:

#/bin/bash

#######################
# Este script muestra #
# la ruta donde nos   #
# encontramos ahora   #
# mismo.              #
#######################

echo "Nos encontramos en la ruta: " `pwd`

Cuando ejecutemos el script, todos los comentarios serán ignorados y no se ejecutarán ni se mostrarán por pantalla. En la siguiente imagen vemos el código del script desde el editor de textos nano:

Comentario multilínea con 

Cuando ejecutemos el script, los comentarios no se muestran:

Ruta actual

4.1.- BLOQUES DE COMENTARIOS UTILIZANDO :

Para usar la notación de dos puntos, debemos escribir los comentarios de bloque entre : ' y el cierre ' como muestro a continuación:

#!/bin/bash
: '
En este script mostramos
el tiempo total que lleva
encendida la máquina.
También mostramos la carga
de la misma.
'
echo "El Uptime y el Load Average es:" `uptime`

Cuando ejecutemos el script, todos los comentarios serán ignorados y no se ejecutarán ni se mostrarán por pantalla. En la siguiente imagen vemos el código del script desde el editor de textos nano:

Comentario multilínea con :'

Cuando ejecutemos el script, los comentarios no se muestran:

Uptime y Load Average

4.1.- BLOQUES DE COMENTARIOS UTILIZANDO DELIMITADOR

Con diferencia, esta es otra de las formas más populares de escribir comentarios de varias líneas en Bash. Se utiliza << seguido de un delimitador (un conjunto de caracteres para especificar el inicio y el final de los comentarios). Así es como debemos usarlo (el delimitador puede ser COMMENT, HELLO, SKIP etc, etc...):

#/bin/bash

<<COMMENT
En este script hacemos Ping 5
veces a uno de los servidores
DNS de Google en Internet.
De esta forma sabemos si la
red funciona bien. Es una prueba
muy básica de red.
COMMENT

ping -c 5 8.8.8.8

En el ejemplo anterior, se ha usado como delimitador COMMENT. Cuando ejecutemos el script, todos los comentarios serán ignorados y no se ejecutarán ni se mostrarán por pantalla. En la siguiente imagen vemos el código del script desde el editor de textos nano:

Comentarios con delimitador

Cuando ejecutemos el script, solo veremos el resultado de hacer Ping a Google:

Ping a Google

ENJOY!