Cómo escribir comentarios en bash correctamente

Cómo escribir comentarios en bash correctamente.

Cuando desarrollamos scripts Bash, tenemos que seguir unas reglas de buenas practicas. El código debe ser limpio y comprensible, organizado por bloques, sangrados y con nombres descriptivos de las variables y funciones.

Otra forma de mejorar el código es con el uso de comentarios. El comentario es una pequeña anotación legible para humanos, donde se explica paso a paso las operaciones a realizar por el script bash.

Esta practica recomendable te ahorrará tiempo y trabajo cuando pasado un tiempo revises de nuevo el código. Por ejemplo, si quieres modificar un script creado hace meses, lo más probable es que no recuerdes por qué escribiste el código de esa manera. Con un comentario lo entenderás enseguida.

Los comentarios también ayudan a otros programadores o sysadmin, que quieran modificar o continuar con tu trabajo. Los comentarios deben ser cortos y directos, no son necesarias las explicaciones obvias ni medias tintas.

En este artículo vemos los conceptos básicos de escritura, para que tus scripts bash tengan unos comentarios eficientes.

 

Cómo escribir comentarios en bash

Lo primero que debes recordar es, que Bash ignora (no ejecuta) todo lo escrito en una línea después de un hash «#» (también conocido como almohadilla). Como única excepción a hash, indicamos cuando en la primera línea del script se inserta algo similar a lo siguiente.

#!/bin/bash

Esto obligará al sistema a usar el intérprete de comandos que nosotros queremos, en el resto del código.

Los comentarios se pueden insertar antes de cada línea o en la misma línea, vemos los dos ejemplos.

# Recopilar los valores VAR1 y VAR2
   read -r -p "Introduce el primer valor: " VAR1
   read -r -p "Ahora el valor a comparar: " VAR2

# o

read -r -p "Introduce el primer valor: " VAR1 # Recopilar valor VAR1
read -r -p "Ahora el valor a comparar: " VAR2 # Recopilar valor VAR2

Si observas los ejemplos anteriores te darás cuenta que después de los hash dejamos un espacio. Realmente no es necesario, pero es evidente que aumenta su legibilidad de manera considerable.

Otra utilidad interesante de los comentarios es, que con el hash (#) puedes anular la ejecución de cualquier línea. Es una buena práctica si  estas probando scripts, o agregas otras funciones que no siempre son necesarias. Vemos un ejemplo.

# Recopilar los valores VAR1 y VAR2 (VAR3 opcional)
   read -r -p "Introduce el primer valor: " VAR1
   read -r -p "Ahora el valor a comparar: " VAR2
  #read -r -p "Compara el resultado con otro valor: " VAR3

 

La inmensa mayoría de lenguajes de programación admiten comentarios multilínea, por su estructura de construcción lectora bash no los admite. Debes insertarlos linea por linea.

# Recopilar el valor VAR1
# Recopilar el valor VAR2
   read -r -p "Introduce el primer valor: " VAR1
   read -r -p "Ahora el valor a comparar: " VAR2

Si no te convence el sistema multilínea, puedes usar HereDoc que es un tipo de redirección que nos permite pasar múltiples líneas de entrada a un comando. Si HereDoc no redirige a ningún comando, lo podemos aprovechar como marcador posicional de comentarios multilínea (hablaremos de HereDoc en un próximo articulo).
cat << 'MULTILINE-COMMENT'
    Las lineas insertadas aqui
    apareceran en el script
    tal como las ves ahora
MULTILINE-COMMENT

 

Nota final: Escribir comentarios es una buena práctica, ayudas a otros desarrolladores, y a ti mismo a comprender el script. En Bash, todo lo que pongas después de hash ( #) y hasta el final de la línea, se considera un comentario.

 

Canales de Telegram: Canal SoloLinux – Canal SoloWordpress

Espero que este articulo te sea de utilidad, puedes ayudarnos a mantener el servidor con una donación (paypal), o también colaborar con el simple gesto de compartir nuestros artículos en tu sitio web, blog, foro o redes sociales.

 

Agregar comentario