Código Limpio

Comunidad
Hacer una pregunta escribir una publicación de blog Inicia
Artículos Técnicos
klaus haeuptle
21 de diciembre de 2022 Lectura | de 7 minutos
Código limpio: escribir código

mantenible, legible y comprobable
Seguir  1  27  41,170
Código limpio es un término utilizado para describir software que es fácil de leer,
 Me gusta comprender, mantener y probar. En este blog quiero resumir algunos principios
importantes y proporcionar una entrada al tema para principiantes. Además, el blog
se conectará con el repositorio de guías de estilo, los libros e iniciativas actuales
 RSS Feed donde los expertos pueden contribuir. Si no quiere perderse una actualización sobre
código limpio, automatización de pruebas, revisiones de código, pruebas unitarias,
toma de decisiones, capacidad de prueba y otros temas de
ingeniería/artesanía/arquitectura, suscríbase al nuevo boletín .
¿Qué hace que el código sea limpio?

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.
¿Qué es el código que no está 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
Beneficios del código limpio

Hay muchos beneficios de escribir código limpio, que incluyen:
Legibilidad y comprensión mejoradas: el código limpio es más fácil de leer y

comprender, lo que puede facilitar a los desarrolladores la adaptación, la
depuración y el mantenimiento.
Menor riesgo de errores y fallas: el código limpio generalmente es más confiable y
menos propenso a errores y fallas, ya que es más fácil de entender, probar y
mantener.
Mayor productividad: el código limpio es más fácil y rápido para trabajar, lo que
puede aumentar la productividad y la eficiencia del desarrollador. Según un
metaestudio, el código no saludable puede contener más de 15 veces más
defectos y reducir la productividad en un factor de 9 .
Mayor capacidad de adaptación y evolución: el código limpio y modular es más
fácil de modificar y actualizar, lo que puede ayudar a que el software evolucione y
se adapte a los requisitos cambiantes a lo largo del tiempo.
Colaboración en equipo mejorada: el código limpio es más fácil de entender y
trabajar para los miembros del equipo, lo que puede mejorar la colaboración y la
comunicación dentro del equipo.
Mejor capacidad de mantenimiento a largo plazo: el código limpio es más fácil de
mantener y actualizar con el tiempo, lo que puede ahorrar tiempo y recursos. Y
reduzca el riesgo si los ingenieros se trasladan a otros proyectos o abandonan la
empresa.
Mayor reutilización de código: el código limpio y modular es más fácil de reutilizar
y readaptar en diferentes contextos, lo que puede ahorrar tiempo y recursos.
Mejor rendimiento: el código limpio generalmente es más eficiente y puede
ejecutarse más rápido, ya que es menos complejo y más fácil de optimizar
cuando es necesario.
Proceso de revisión de código mejorado: el código limpio es más fácil de revisar,
ya que está más organizado y es más fácil de entender. Esto puede conducir a
revisiones de código más eficientes y efectivas.
Reputación mejorada: escribir un código limpio puede ayudar a mejorar la
reputación del desarrollador o del equipo de desarrollo, ya que demuestra un
compromiso con la calidad y la profesionalidad.
En general, el código limpio puede ayudar a garantizar que su software sea confiable,
mantenible y fácil de usar, lo que puede conducir a una mayor eficiencia,
productividad, mayor calidad y mayor satisfacción de los desarrolladores y usuarios
por igual. Los beneficios del código limpio se extienden más allá del proceso de
desarrollo y pueden tener un impacto positivo en el éxito a largo plazo del software y
del equipo que trabaja en él.
Principios y ejemplos importantes de Clean Code

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.
El repositorio de la guía de estilo

https://github.com/SAP/styleguides
Bajo la licencia CC BY 3.0 y abierto a contribuciones de dentro y fuera de SAP,

esperamos que este repositorio ayude a los desarrolladores de todo el mundo a
hacer su código un poco más limpio, día a día.
El objetivo a largo plazo del repositorio de guías de estilo es cubrir los lenguajes de
programación más importantes del mundo SAP. Hasta ahora solo se cubre ABAP,
pero estoy convencido de que vendrán más. Tal vez también podamos cubrir Java,
TypeScript, Kotlin, Go y más, más bien un deseo que cercano a la realidad.
Los libros
Hay varios libros que cubren el tema en detalle, explican el razonamiento y lo aplican
a lenguajes de programación específicos.
Limpiar ABAP
Clean ABAP - Versión alemana
Limpiar SAPUI5
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.
Familia de libros de códigos limpios para ABAP y SAPUI5/JavaScript
Una base para la mejora

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 del código coherente 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.
Fomentar 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 guía de estilo, permite a los ingenieros saltar a una
parte desconocida del código y realizar mejoras rápidamente .
Mejorar la experiencia del desarrollador: tener una guía de estilo coherente crea
un ecosistema por sí solo 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 a los
nuevos desarrolladores más rápidamente y centrar el tiempo en la programación
en pareja o las revisiones de código en otros aspectos.
También se benefician otros roles, no solo desarrolladores , por ejemplo,
consultores que necesitan hacer extensiones o equipos SRE (Site Reliability
Engineering) que necesitan mejorar las operaciones.
La coherencia también mejora el mantenimiento a largo plazo, ya que los nuevos
ingenieros que toman posesión pueden comprender más rápidamente y
mantener el código.
La guía de estilo permite hacer cumplir las reglas con controles 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.
Actividades actuales
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 un 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.
Suscríbete al Newsletter para

mantenerte informado
Si no quiere perderse una actualización sobre código limpio, automatización de
pruebas, revisiones de código, pruebas unitarias, toma de decisiones, capacidad de
prueba y otros temas de ingeniería/artesanía/arquitectura, suscríbase al nuevo
boletín . El boletín no solo se utilizará para compartir conocimientos, sino que
también ofrecerá oportunidades para la colaboración, la construcción de
comunidades y la creación conjunta.
Moderador de alertas
Etiquetas asignadas
Desarrollo ABAP
Java
JavaScript
Fuente abierta
Investigación y desarrollo
SAPUI5
Código limpio ABAP
Ver más... 
Publicaciones de blog similares 

Aprendizaje simplificado de clean abap y clean ui5
Por Klaus Haeuptle 14 de junio de 2022
Traducciones ABAP limpias y versión alemana del libro
Por Klaus Haeuptle 05 de enero de 2022
Capacidad de prueba: crítica, pero a veces olvidada

Por Klaus Haeuptle 15 de diciembre de 2021
preguntas relacionadas 
Comparar datos entre dos tablas internas
Por ex miembro 25 de junio de 2008
Desafío de codificación de la comunidad de SAP: marzo de 2020

Por Thomas Jung 17 de marzo de 2020
El módulo de función no funciona de manera consistente

Por ex miembro 11 de diciembre de 2008
1 comentario
Debe iniciar sesión para comentar o responder a una publicación.
Conjunto Kiran NC
22 de diciembre de 2022 a las 5:58 am
Nadie siente el valor del código limpio que alguien como yo en las operaciones de SAP, especialmente en el
momento de la necesidad. ¡Sin olvidar el beneficio en términos de impacto comercial reducido y MTTR! ¡Gran
blog en general y debe ser obligatorio para todos los programadores! ¡Gracias por compartir tu pensamiento!
como 4 | Cuota
Encuéntranos en
Privacidad Términos de Uso
Divulgación legal Derechos de autor
Marca comercial Preferencias de cookies
Boletin informativo Soporte

Código Limpio

Cargado por

Copyright:

Formatos disponibles

Código Limpio

Cargado por

Información del documento

Descripción original:

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Código Limpio

Cargado por

Copyright:

Formatos disponibles

Comunidad

Hacer una pregunta escribir una publicación de blog Inicia

Código limpio: escribir código

¿Qué hace que el código sea limpio?

¿Qué es el código que no está limpio?

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

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

Beneficios del código limpio

Legibilidad y comprensión mejoradas: el código limpio es más fácil de leer y

Principios y ejemplos importantes de Clean Code

El código limpio facilita que los desarrolladores comprendan, modifiquen y

El repositorio de la guía de estilo

Bajo la licencia CC BY 3.0 y abierto a contribuciones de dentro y fuera de SAP,

Familia de libros de códigos limpios para ABAP y SAPUI5/JavaScript

Una base para la mejora

En los últimos meses hemos trabajado en documentar todo el proceso y anotado

Suscríbete al Newsletter para

Código limpio ABAP

Publicaciones de blog similares 

Capacidad de prueba: crítica, pero a veces olvidada

Desafío de codificación de la comunidad de SAP: marzo de 2020

El módulo de función no funciona de manera consistente

Debe iniciar sesión para comentar o responder a una publicación.

Divulgación legal Derechos de autor

Marca comercial Preferencias de cookies

Boletin informativo Soporte

También podría gustarte