jueves, 3 de diciembre de 2015

¿Por qué son importantes los comentarios?

Siempre que modificas archivos de configuración es una buena idea añadir algunos comentarios para documentar tus cambios. Seguro que mañana recordarás lo que has cambiado, pero ¿qué pasará dentro de seis meses? Hazte un favor y añade algunos comentarios. Mientras estás en ello, no es mala idea guardar un registro de los cambios que haces.

Los scripts de shell y los archivos de arranque de bash usan el símbolo “#” para comenzar un comentario. Otros archivos de configuración pueden usar otros símbolos. La mayoría de los archivos de configuración tendrán comentarios. Úsalos como guía.

A menudo verás líneas en archivos de configuración que están comentadas para evitar que sean usadas por el programa afectado. Esto se hace para dar al lector recomendaciones para posibles configuraciones o ejemplos de la sintaxis de configuración correcta. Por ejemplo, el archivo .bashrc de Ubuntu 8.04 contiene estas líneas:

# some more ls aliases
#alias ll='ls -l'
#alias la='ls -A'
#alias l='ls -CF'

Las últimas tres líneas son definiciones válidas de alias que han sido comentadas. Si eliminas los símbolos “#” de delante de las tres líneas, una técnica llamada descomentar, activarás los alias. Inversamente, si añades un símbolo “#” al principio de una línea, puedes desactivar una linea de configuración mientras que conservas la información que contiene.

No hay comentarios:

Publicar un comentario