Guías de estilo
Las guías de estilo son documentos que definen un conjunto de convenciones de programación, es decir, un conjunto de buenas prácticas, métodos de programación y otras reglas que garantizan el desarrollo de programas de manera consistente. Por ejemplo, las guías de estilo se encargan de documentar aspectos de los programas relativos a cómo deberíamos nombrar nuestras variables, o si deberíamos utilizar espacios o tabulaciones para indentar el código, entre otros aspectos.
Aunque las guías de estilo suelen utilizarse principalmente durante el desarrollo de proyectos software en equipo, su efectividad en proyectos individuales está más que asegurada; es mucho más sencillo leer y entender el código de un programa que sigue una guía de estilo de manera consistente que el de otro que no lo hace.
Existen multitud de guías de estilos, tantas como lenguajes de programación hay o incluso más de una por lenguaje. Como programadores, podemos elegir la guía de estilo que prefiramos en función del soporte existente, la documentación y la facilidad de adopción. Lo importante es que seamos consistentes con la guía de estilo que elijamos para el desarrollo de nuestro programa y no mezclemos diferentes guías de estilo para un mismo proyecto.
Entre los beneficios que nos aportan las guías de estilo, podemos destacar los siguientes:
-
Mejoran la legibilidad del código, facilitando su lectura y comprensión.
-
Facilita que otros desarrolladores puedan realizar contribuciones a nuestros programas. Del mismo modo, nos permiten implicarnos rápidamente en el desarrollo de otros programas que usen guías de estilo con las que ya estemos familiarizados.
-
Nos ayudan a centrarnos en lo que realmente importa, es decir, desarrollar nuestros programas.
Un caso de guía de estilo sería la PEP 8 o Guía de Estilo para Código Python, creada por el propio autor del lenguaje Python, Guido van Rossum. Esta guía de estilo proporciona indicaciones sobre la organización del código, nombrado de variables y otros elementos del lenguaje, uso de comas o entrecomillado de cadenas de texto, entre otros.
Por ejemplo, PEP 8 aconseja nombrar las variables y funciones en minúsculas y separando las distintas palabras con guiones bajos. Algunos ejemplos válidos de nombres de variables que se ajustan a lo que indica esta regla serían numero_de_aprobados o contador, mientras que algunos ejemplos incorrectos serían numeroDeAprobados o CONTADOR.
Además de las guías de estilo, podemos también mejorar la legibilidad de nuestros programas y su mantenibilidad futura documentando aquellas partes del código más complejas o en las que consideremos que merece la pena hacer hincapié. Añadiendo comentarios al código podemos realizar esta documentación directamente sobre el propio código del programa, de tal forma que cualquier programador pueda revisar dichos comentarios durante la etapa de desarrollo.
En este contexto, la guía de estilo PEP 8 también da algunas indicaciones sobre el uso de comentarios en el código como, por ejemplo, añadir comentarios que realmente aporten algo al lector y no expongan obviedades, o documentar utilizando comentarios en inglés, entre otras:
# Improves the accuracy by 5% to reduce possible detection errors x = x * 1.05