Herramientas de usuario

Herramientas del sitio


ada:howto:sicoferp:factory:cleancode

¡Esta es una revisión vieja del documento!


Buenas prácticas de desarrollo de software: Principios Clean Code (Código Limpio)

Esta sección presenta las 7 reglas principales del Clean Code (Código Limpio). La información ha sido adaptada tomando como referencia el portal https://www.hostgator.mx/blog/clean-code-codigo-limpio/

El concepto de código limpio se le atribuye a Robert Cecil Martin, un destacado ingeniero de software que popularizó este término en su libro “Clean Code: Refactoring, Patterns, Testing and Techniques for Clean Code”. No obstante, los principios subyacentes a la idea de código limpio tienen raíces mucho más profundas y no se limitan exclusivamente al ámbito de la programación. A continuación, te ofrecemos una explicación sobre lo que implica el código limpio, sus beneficios y cómo llevarlo a la práctica.

¿Que es Clean Code?

El código limpio no se basa en reglas rígidas, sino en una serie de principios que promueven la creación de un código intuitivo y fácil de modificar. En este contexto, la intuición implica que cualquier profesional de desarrollo pueda comprenderlo de inmediato. Un código que es fácilmente adaptable presenta las siguientes características:

  • El flujo de ejecución del programa sigue una lógica clara y tiene una estructura sencilla.
  • Las relaciones entre las distintas partes del código son transparentes.
  • La función de cada clase, función, método y variable es evidente a simple vista.

Un código se considera fácil de modificar cuando es flexible y extensible, lo que facilita la corrección de posibles errores. Por estas razones, el código limpio resulta sencillo de mantener y exhibe las siguientes cualidades:

  • Las clases y los métodos son concisos y, siempre que sea posible, tienen una única función bien definida.
  • Las clases y los métodos son predecibles, operan de acuerdo a las expectativas y se acceden a través de API (interfaces) claramente documentadas.
  • El código ha sido sometido a pruebas unitarias.

Las ventajas de este enfoque de programación son evidentes: el código limpio se vuelve independiente del desarrollador que lo creó. En esencia, cualquier programador puede trabajar con él, lo que evita los problemas asociados con el código heredado. Además, el mantenimiento del software se simplifica, ya que los errores son más fáciles de identificar y corregir1).

Notas

  • Toda actualización debe estar soportada por un ticket o control de cambios.
  • Toda actualización debe estar validada exitosamente por el rol de QA.
  • El versionamiento aplica para la liberación de release.
  • Cada versión debe ser almacenada en su repositorio especifico.

←Volver atras

ada/howto/sicoferp/factory/cleancode.1699362424.txt.gz · Última modificación: 2023/11/07 13:07 por 192.168.175.10