Mente, escritura y felicidad
6 de mayo 2022
¿Qué sabes de la mantenibilidad?
Las estadísticas demuestran que los desarrolladores que trabajan con un código más limpio se sienten en mejores condiciones de trabajo, son más felices y, en consecuencia, producen más. Esto nos lleva directamente al concepto del código limpio.
El arte de trabajar en un proyecto creado con técnicas ágiles, garantiza la calidad del código y conduce directamente a la mantenibilidad.
Pero, ¿qué es exactamente el código limpio?
Empezando por el principio, el término fue nombrado por Robert Cecil Martin en 2008, en su libro “Clean Code: A Handbook of Agile Software Craftsmanship”. El predecesor, autor e impulsor del Manifiesto Ágil, es conocido por desarrollar varios de los principios del diseño de software. Fue él quien identificó que el principal problema en el desarrollo de software era el código y, como resultado, estableció técnicas para mejorar y programar proyectos.
Para los programadores, crear un código limpio es como una obra de arte. Algunos autores especializados en la materia lo describen así:
-
Grady Booch, autor de Object Oriented Analysis and Design with Applications: El código limpio es simple y directo, se lee como un texto bien escrito y no oculta la intención del diseñador, sino que muestra abstracciones y líneas de control claras.
-
Dave Thomas, fundador of OTI, el padrino de la estrategia de Eclipsey: El código limpio puede ser leído y mejorado por un programador que no sea su autor original. Tiene pruebas unitarias y de aceptación. Tiene nombres significativos. Ofrece una, y no varias, formas de hacer algo. Tiene dependencias mínimas, está definido explícitamente y ofrece una API clara y mínima. El código debe ser culto en términos de lenguaje, ya que no toda la información puede expresarse claramente en el código.
Una mirada a los principios del código limpio, establecidos por Martin
Se elegante con el código para evitar un trabajo más arduo y costoso. La simplicidad y el minimalismo también están inmersos en la programación, teniendo los mismos efectos que en la vida. Cuanto menos desordenado esté un espacio, menos energía gastará nuestro cuerpo en él, lo mismo ocurre con nuestro proyecto, si está menos desordenado, más fácil será trabajar en él y más a gusto nos sentiremos.
Utiliza el sentido común a la hora de asignar nombres. Elegir nombres que estén asociados a la acción que indican y que sean legibles facilitará el trabajo a los programadores que tengan que trabajar en el mismo proyecto en el futuro.
Haz que cada función sea lo más pequeña posible y que haga una sola función, es decir, funciones distintas para cada acción que quieras programar.
Y sobre todo, los comentarios que hagas deben ser de calidad, necesarios y correctos.
“La verdad sólo se puede encontrar en un lugar: el código”
¿Qué herramientas pueden ayudarte?
Como buen programador, debes trabajar con SonarQube (on-premise) or SonarCloud (as a service), una herramienta que te permite trabajar en la calidad y seguridad de tu código, gracias a que identifica evidencias en fiabilidad, seguridad, y mantenibilidad, y te ofrece métricas como la cobertura o el código repetido.
Es importante poder visualizar con suficiente abstracción todos los datos de la calidad del código para mejorarlo.
El plugin Overview Report for SonarQube or SonarCloud puede ofrecerte un informe de una sola página con las métricas agregadas de todos tus proyectos. Incluye también soporte a inglés y español, acceso a todos los lenguajes y tecnologías de SonarCloud, y personalización del logo en el pie de página.
Si quieres introducirte en la programación, te recomendamos esta lectura “Clean Code: A Handbook of Agile Software Craftsmanship”.
bitegarden team
Helping companies to develop better software