Linux en español
Tutoriales

Cómo escribir comentarios en los scripts de Bash

Cómo escribir comentarios en los scripts de Bash
3 minutos de lectura

Al escribir scripts de Bash, siempre es una buena práctica para hacer que su código limpio y fácil de entender. La organización de su código en bloques, sangría, dando a las variables y funciones de nombres descriptivos son varias maneras de hacer esto.

Otra forma de mejorar la legibilidad del código es mediante el uso de comentarios. Un comentario es una legibles explicación o anotación que está escrito en la secuencia de comandos de shell.

Agregar comentarios a tus scripts de Bash le ahorrará un montón de tiempo y esfuerzo cuando usted mira su código en el futuro. Digamos que usted desea cambiar de un guión que escribió un par de meses o años. Las posibilidades son que usted no va a recordar por qué escribió algunos complicada pieza de código, a menos que usted ha añadido un comentario.

Los comentarios también ayudar a otros desarrolladores y administradores de sistema que puede necesitar para mantener la secuencia de comandos para entender su código y su propósito.

Los comentarios se utilizan generalmente para explicar lo que el código no puede. Por ejemplo, si usted tiene un complejo de regex o la sustitución de parámetros en el interior de su script de Bash, usted debe escribir un comentario acerca de lo que hace el código. Los comentarios deben ser breves y al punto. No explicar algo que es simple y obvio para el lector.

En este artículo vamos a cubrir los conceptos básicos de la escritura de comentarios en Bash.

Bash ignora todo lo que está escrito después de la almohadilla (#) en la línea. La única excepción a esta regla es cuando la primera línea en el script comienza con la #! los caracteres. Esta secuencia de caracteres que se llama el Proceso y se utiliza para indicar al sistema operativo que interprete a utilizar para analizar el resto del archivo.

Se pueden añadir comentarios al principio de la línea o en línea con otros código:

# Este es un comentario en bash.
echo "This is Code" # This is an inline Bash comment.

El espacio en blanco después de la marca no es obligatorio, pero va a mejorar el comentario de la legibilidad.

Generalmente, cuando la secuencia de comandos que se abre en un editor de texto, los comentarios están representadas en verde.

Los comentarios también son útiles cuando se prueba una secuencia de comandos. En lugar de la eliminación de algunas líneas o bloques, puede comentar de ellos:

# if [[ $VAR -gt 10 ]]; then
#  echo "Variable is greater than 10."
# fi

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 añadir comentarios, uno tras otro:

# Esta es la primera línea.
# Esta es la segunda línea.

Otra opción es utilizar HereDoc. Es un tipo de redirección que le permite pasar varias líneas de entrada a un comando. Si el HereDoc bloque no es redirigido a un comando, puede servir como un comentarios multilínea marcador de posición:

<< 'MULTILINE-COMMENT'
    Everything inside the
    HereDoc body is
    a multiline comment
MULTILINE-COMMENT

El uso de HereDoc es un hack, no es un verdadero integrada de la manera de escribir de varias líneas de Bash comentarios. Para evitar problemas, se debe preferir el uso de una sola línea de comentarios.

Conclusión

La escritura de comentarios es una buena práctica y ayuda a otros desarrolladores, incluyendo el futuro de uno mismo, para entender la secuencia de comandos de shell. En Bash, todo después de la marca de hash (#) y hasta el final de la línea se considera un comentario.

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

Puntuación media / 5. Recuento de votos:

¡Síguenos en redes sociales!

Entradas relaccionadas

Cómo instalar VestaCP en Linux

Diego García Cuesta

Una instalación limpia de Ubuntu 18.04 con Unity desde mini ISO

Linux en Español

Cómo actualizar Debian 7 Wheezy a Debian 8 Jessie

Diego García Cuesta

Monitorear archivos y carpetas en tu Linux con incron && incrontab

Diego García Cuesta

3 Maneras fáciles de crear medios USB de arranque a partir de ISO en Ubuntu

Diego García Cuesta

Instalar Arch GNU/Linux puro desde un live CD

Linux en Español