Código limpio: escribir código mantenible, legible y comprobable

Lograr un código limpio implica seguir un conjunto de mejores prácticas y estándares, como usar nombres significativos, mantener las funciones pequeñas y enfocadas, y usar los comentarios con moderación. Tener una base de código que sea legible y mantenible es esencial para el desarrollo sostenible. Los libros Clean Code de Robert C. Martin, Code Complete de Steve McConnell, The Pragmatic Programmer de David Thomas/Andy Hunt y algunos otros libros contienen muchas prácticas recomendadas y ejemplos de código limpio.

El código que no está limpio es un código difícil de leer, comprender y mantener. Puede tener una organización deficiente, nombres confusos o engañosos, un estilo inconsistente y otros problemas que dificultan el trabajo.

Algunos ejemplos de código que no está limpio pueden incluir:

• Código con funciones largas y complejas que son difíciles de entender, probar y mantener.
• Código con convenciones de nomenclatura deficientes, como variables con nombres cortos y no descriptivos, o funciones con nombres que no reflejan con precisión su propósito.
• Código con estilo inconsistente, como sangría o espaciado inconsistente, lo que puede dificultar la lectura y comprensión.
• Codifique con código innecesario o redundante, lo que puede dificultar su mantenimiento y comprensión.
• Código que dificulta la automatización de pruebas, por ejemplo, acoplamiento estático entre clases.

En general, el código que no está limpio a menudo es más propenso a errores y fallas, y puede llevar más tiempo trabajar con él, ya que requiere más esfuerzo para comprenderlo, probarlo y mantenerlo.

Calidad de código de xkcd.com/1513/ bajo Creative Commons BY-ND 2.5

Hay muchos beneficios de escribir código limpio, que incluyen:

Primero, resumamos algunos principios importantes para un código limpio y proporcionemos algunos ejemplos simples. Para cada principio hay mucho más que aprender en la guía de estilo y en los libros.

• El código limpio facilita que los desarrolladores comprendan, modifiquen y mantengan un sistema de software. Cuando el código está limpio, es más fácil encontrar y corregir errores, y es menos probable que se rompa cuando se realizan cambios.
• Uno de los principios clave del código limpio es la legibilidad, lo que significa que el código debe ser fácil de entender, incluso para alguien que no esté familiarizado con el sistema. Para lograr esto, los desarrolladores deberían, por ejemplo, usar nombres significativos para variables, funciones y clases.
• Otro principio importante del código limpio es la simplicidad, lo que significa que el código debe ser lo más simple posible, sin complejidades innecesarias. Para lograr esto, los desarrolladores deben evitar el uso de estructuras de datos o algoritmos complejos a menos que sean necesarios, y deben evitar agregar características o funcionalidades innecesarias.
• Además de la legibilidad y la simplicidad, el código limpio también debe poder mantenerse, lo que significa que debe ser fácil de modificar y actualizar el código sin romperlo. Para lograr esto, los desarrolladores deben escribir código modular que esté organizado en funciones pequeñas y enfocadas, y deben evitar la duplicación de código.
• Finalmente, el código limpio debe estar bien documentado. Esto significa que debe incluir comentarios claros y concisos que expliquen el propósito y la funcionalidad del código. Sin embargo, los comentarios no deben usarse para explicar el código en sí; el código debe escribirse de forma que se explique por sí mismo.

En general, el código limpio es una parte esencial del desarrollo de software. Facilita la comprensión y el mantenimiento de un sistema, y ​​puede ayudar a prevenir errores y otros problemas.

Hay varios libros que cubren el tema en detalle, explican el razonamiento y lo aplican a lenguajes de programación específicos.

Los libros también son muy adecuados para principiantes o principiantes para aprender los lenguajes de programación. O compañeros que ya dominan Clean ABAP y quieren aprender Clean SAPUI5. E incluso expertos en el lenguaje de programación mencionaron que aprendieron mucho y fue una fuente de inspiración.

Los principales beneficios de tener una comprensión común de un estilo de código en un lenguaje de programación determinado son la capacidad de mantenimiento, la legibilidad y la capacidad de prueba mejoradas. Pero también hay muchos otros beneficios y nuevas posibilidades, que este blog explora con más detalle:

• ¿Por qué tener un conjunto común de reglas? A medida que una organización crece, ayuda a mantener la base de código consistente y permite que los desarrolladores se concentren en los aspectos importantes. Habrá menos conflictos sobre conceptos básicos (por ejemplo, formato) debido a un estilo de código estándar.
• Fomentando el principio de optimizar el código para el lector: Dado que el código se leerá con mucha más frecuencia de lo que se escribe, un principio importante para todas las reglas es optimizar para el lector, no para el escritor. Por lo tanto, la guía de estilo valora más la legibilidad que el uso de expresiones poderosas, que le permiten al escritor expresar algo de manera concisa, pero luego son difíciles de leer.
• Coherencia de la base de código: si la base de código se crea teniendo en cuenta los mismos principios y la misma guía de estilo, permite a los ingenieros saltar a una parte desconocida del código y hacer mejoras rápidamente.
• Mejorar la experiencia del desarrollador: Tener una guía de estilo coherente crea un ecosistema por sí mismo y permite mejorar la experiencia del desarrollador. Después de que se publicó la guía de estilo en 2019, la comunidad comenzó a crear herramientas para mejorar las revisiones de código, documentó las prácticas de revisión de código, verificó el código estático extendido, desarrolló formatos de capacitación y creó algunas herramientas para corregir el código automáticamente. Esta coherencia creó la base para varios proyectos InnerSource/de código abierto, mejoras de la plataforma y desencadenó la exploración de nuevas ideas.
• Escalar una organización: a medida que crece una organización, es importante tener una comprensión común del estilo del código. ayuda a impulsar nuevos desarrolladores más rápidamente y centrar el tiempo en programación en pareja o revisiones de código en otros aspectos.
• también otros roles, no solo los desarrolladores, se beneficianpor ejemplo, consultores que necesitan hacer ampliaciones o equipos SRE (Site Reliability Engineering) que necesitan mejorar las operaciones.
• La consistencia también mejora el mantenimiento a largo plazo ya que los nuevos ingenieros que toman posesión pueden entender más rápidamente y mantener el código.
• La guía de estilo permite hacer cumplir las reglas con verificaciones de código estático o incluso desarrollar correcciones automáticas. Por lo tanto, algunas discusiones ya no tienen lugar, lo que permite enfocar el tiempo de los desarrolladores en aspectos más importantes.

Con el éxito de la guía de estilo y la cantidad de propuestas de mejora surge la necesidad de un proceso más formal cuando se trata de revisar las propuestas de mejora. Hacer transparente todo el proceso y tener claridad para la toma de decisiones.

Esto incluye claridad sobre cómo se deben abrir, se procesan y el plazo típico en el que de alguna manera se puede esperar una decisión. Además, especialmente para cambios con mayor impacto (por ejemplo, cambios incompatibles), necesitamos un proceso formal para la toma de decisiones, ya que esos cambios también se verán reflejados en las verificaciones de código estático y, por lo tanto, afectarán a una gran cantidad de desarrolladores.

En los últimos meses hemos trabajado en documentar todo el proceso y anotado nuestros principios rectores para involucrar a la comunidad y tomar decisiones. Próximamente se publicará el proceso.