Del curso: Bash Scripting desde cero

Permisos de ejecución (chmod +x) - Tutorial de Bash

Del curso: Bash Scripting desde cero

Comenzar mi mes de prueba gratis Comprar para mi equipo

Permisos de ejecución (chmod +x)

“

Bueno, rapidito. En este capítulo, vas a aprender cómo documentar tus scripts: comentarios de línea, cabeceras con metadatos como esta o notas dentro del código. Todo lo que va detrás de hashtag, almohadilla, como le llames, hasta el final de la línea es un comentario. Úsalo para explicar el porqué y no para describir lo obvio. Me explico. No es lo mismo que tú escribas que esto es un «hola mundo» y expliques: Esto escribe por pantalla un «hola mundo» a que escribas una cabecera donde expliques cómo se llama el archivo, qué es lo que hace, quién es el autor, la fecha y la versión. Si quieres, para párrafos, como ves, pues usa varias almohadillas. Y para desactivar una línea, como ha pasado aquí, simplemente le tienes que añadir la almohadilla. En este caso, queremos que vuelva a funcionar y ponemos las comillas. Si ponemos una almohadilla, esto desactiva toda la línea. Aunque lo veas de otro color, la desactiva. Algo importante, casi todo se documenta más o menos igual. Sin embargo, una de las cosas que vas a aprender a hacer durante este curso van a ser funciones. Documentar las funciones tiene un proceso que debería ser estándar y que es muy concreto, que es explicar el nombre de la función, explicar qué es lo que hace la función, cómo se usa, los parámetros que admite, es decir, las variables que admite, la salida y el retorno. Te voy a explicar más adelante qué es salida y qué es retorno si no sabes de funciones. Y debajo, comienzas la función y pones tu código. Este patrón te obliga a pensar en la interfaz de la función, en lugar de explicar línea a línea qué es lo que hace, porque leer una función sabe todo el mundo, pero la toma de decisiones no siempre la entiende todo el mundo. Entonces, y reitero, escribir el porqué de una decisión es lo que debemos hacer en lugar de escribir qué es lo que hace la línea. Hay un par de etiquetas que son interesantes que se les suelen poner a las notas o a los scripts para llevar un cierto control, que son TODO, FIXME y NOTE. Puedes poner, por ejemplo, un TODO antes de la función que habías escrito de validar parámetros y, luego, lo buscas, todos los TODO que tienes y vas probando. Puedes poner un FIXME, por ejemplo, de manejar los negativos dentro de la función suma para poner una excepción o para poner un bloque donde manejes los negativos en concreto de esa función. Y puedes poner también la etiqueta NOTE, que la etiqueta NOTE es explicativa. Te explica qué es lo que vas a hacer, notas, cualquier apunte, cualquier cosa que quieras que vea la gente cuando lea tu script y que no sea explícitamente parte de la cabecera. Hay un set de errores frecuentes, que son los más importantes que te voy a explicar, que son: cabeceras kilométricas, poner aquí toda tu vida. La cabecera, con que pongas el nombre, qué es lo que hace, quién es el autor, si quieres, la fecha y la versión, va sobradamente. Comentarios desactualizados. Cada vez que cambies el código, actualiza los comentarios, quita y pon a medida que vayas revisando y a medida que vayas tomando decisiones respecto a tu código. Y describir lo obvio. No es lo mismo que yo te escriba «Aquí vamos a hacer una instalación de paquetes y añadir alias» que que te escriba «Esto pasa por pantalla un hola mundo». Con comentarios claros y funciones documentadas, tus scripts van a ser muchísimo más fáciles de entender y mantener. Y en el siguiente capítulo, conectaremos esta ayuda con el parseo de opciones y seguiremos construyendo un script de verdad.

Contenido